verification

Provide applicant information

Changed on Nov 12, 2026

Save information for the business applicant and its related individual applicants in the entity graph. This updates an editable verification submission; it does not send anything for review. People are addressed by a stable key chosen by the caller, so retrying the same body updates the same entities. Omitting people leaves the roster unchanged; sending people: [] removes only caller-managed people. ready: false is a successful draft write and missing names every outstanding field or document.

put/client/kyb

Request

The document declares no server URL.
Auth
HTTP bearer
TypeScript
https://skmtc.dev/hevn-inc/apis/hevn-api/docs/client/kyb/put.ts
A function with typed inputs. Its response is checked against the schema.

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 required

The selected client account, as a cl_… id.

Example:cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41

Request body

Example request

{
  "people": [
    {
      "documents": [
        {
          "uploadId": "doc_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"
        }
      ]
    }
  ],
  "documents": [
    {
      "uploadId": "doc_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"
    }
  ]
}

Response

Successful Response

readyboolean required

Whether all known requirements are satisfied and completion can be attempted.

missingstring[]

Outstanding applicant fields or document slots.

Changes

Nov 12, 2026299a3aa6f521 Revision changes
- breaking
  removed the enum value directors_registry of the request property ///
- breaking
  removed the enum value directors_registry of the request property //////
- breaking
  removed the enum value list_of_authorized_signatories of the request property ///
- breaking
  removed the enum value list_of_authorized_signatories of the request property //////
- warning
  added the new verification_not_applicable enum value to the / response property for the response status
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- 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
Oct 23, 2026a02795de2d2b Revision changes
- warning
  deleted the header request parameter x-api-key
- warning
  added the new client_already_linked 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 payout_not_awaiting_signature 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
- info
  added the new audited_financial_statement enum value to the request property ///
- info
  added the new audited_financial_statement enum value to the request property //////
- info
  added the new bank_verification_letter enum value to the request property ///
- info
  added the new bank_verification_letter enum value to the request property //////
- info
  added the new cap_table enum value to the request property ///
- info
  added the new cap_table enum value to the request property //////
- info
  added the new certificate_of_registration enum value to the request property ///
- info
  added the new certificate_of_registration enum value to the request property //////
- info
  added the new corporate_resolution enum value to the request property ///
- info
  added the new corporate_resolution enum value to the request property //////
- info
  added the new directors_registry enum value to the request property ///
- info
  added the new directors_registry enum value to the request property //////
- info
  added the new ein_letter enum value to the request property ///
- info
  added the new ein_letter enum value to the request property //////
- info
  added the new flow_of_funds enum value to the request property ///
- info
  added the new flow_of_funds enum value to the request property //////
- info
  added the new identity_verification_attestation enum value to the request property ///
- info
  added the new identity_verification_attestation enum value to the request property //////
- info
  added the new independent_aml_audit_report enum value to the request property ///
- info
  added the new independent_aml_audit_report enum value to the request property //////
- info
  added the new institutional_investor_documentation enum value to the request property ///
- info
  added the new institutional_investor_documentation enum value to the request property //////
- info
  added the new investment_agreement enum value to the request property ///
- info
  added the new investment_agreement enum value to the request property //////
- info
  added the new national_id_back enum value to the request property ///
- info
  added the new national_id_back enum value to the request property //////
- info
  added the new national_id_front enum value to the request property ///
- info
  added the new national_id_front enum value to the request property //////
- info
  added the new operating_license enum value to the request property ///
- info
  added the new operating_license enum value to the request property //////
- info
  added the new org_structure_chart enum value to the request property ///
- info
  added the new org_structure_chart enum value to the request property //////
- info
  added the new payroll_register enum value to the request property ///
- info
  added the new payroll_register enum value to the request property //////
- info
  added the new proof_of_operating_address enum value to the request property ///
- info
  added the new proof_of_operating_address enum value to the request property //////
- info
  added the new proof_of_registered_address enum value to the request property ///
- info
  added the new proof_of_registered_address enum value to the request property //////
- info
  added the new tax_certificate enum value to the request property ///
- info
  added the new tax_certificate enum value to the request property //////
- 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

Operation history (9 revisions)