verification

Retrieve the verification submission

Changed on Nov 12, 2026

Return the current editable applicant information, related people, filed documents, outstanding requirements and the latest review status. missing is authoritative for whether complete can succeed. A pending or completed review is read-only as an application snapshot; later draft edits apply to the next submission.

get/client/kyb

Request

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

Headers

X-Hevn-Accountstring required

The selected client account, as a cl_… id.

Example:cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41

Response

Successful Response

readyboolean required

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

missingstring[]

Outstanding applicant fields or document slots.

status'notStarted' | 'pending' | 'approved' | 'rfi' | 'rejected'

Example response

{
  "application": {
    "id": "kyb_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"
  },
  "document": {
    "company": {
      "expectedMonthlyVolumeUsd": "500.00",
      "expectedCryptoMonthlyVolumeUsd": "500.00",
      "expectedMonthlyAchUsd": "500.00",
      "expectedMonthlyWireUsd": "500.00",
      "estimatedAnnualRevenue": "500.00"
    },
    "people": [
      {
        "documents": [
          {
            "uploadId": "doc_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"
          }
        ]
      }
    ],
    "documents": [
      {
        "uploadId": "doc_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"
      }
    ]
  }
}

Changes

Nov 12, 2026299a3aa6f521 Revision changes
- warning
  added the new verification_not_applicable enum value to the / response property for the response status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  removed the directors_registry enum value from 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 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
Oct 23, 2026a02795de2d2b Revision 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 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 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 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 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 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 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 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 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 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 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 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 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_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 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 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 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 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_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 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
- 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

Operation history (9 revisions)