HEhevn-inc
accounts

Retrieve one account

Changed on

Retrieve the client selected by X-Hevn-Account. Unknown, malformed and foreign account ids share the same not-found response.

get/client

Request

Headers

X-Hevn-Accountstring required

The selected client account, as a cl_… id.

Example:cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41

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

      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

    • info

      added the required property // to the response with the status