HEhevn-inc
accounts

Connect an existing account

Changed on

Exchange the short-lived code the account holder approved in the HEVN sign-in window for access to their account. The account holder keeps signing their own transfers: a payout for this client answers with authorization: client and no approval, and the holder approves it in the HEVN sign-in window. Linking the same account again returns it.

post/clients/link

Request

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

codestring required

Short-lived code the account holder approved in the HEVN sign-in window.

Response

Successful Response

idstring required

Stable public identifier for this account.

status'provisioning' | 'ready' | 'failed' required
namestring nullable

Legal or trading name of the account.

emailstring nullable

Email address associated with the account.

phonestring nullable

Phone number in international E.164 format.

baseSmartWalletstring nullable

Base smart-wallet address controlled by the account.

kybStatus'notStarted' | 'pending' | 'approved' | 'rfi' | 'rejected'
kybApplicationIdstring nullable

Latest immutable business-verification application identifier.

verifiedAtstring date-time nullable

When the account was verified: identity verification for a person, KYB for a business.

createdAtstring date-time required

UTC timestamp when the account was created.

pollUrlstring nullable

Relative API URL to poll with this response's id in X-Hevn-Account.

Example response

{
  "id": "cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "kybApplicationId": "kyb_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"
}

Changes

  • 299a3aa6f521Revision 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

      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
    • info

      endpoint added