Skip to main content
GET
Get Account Details
The GET /v2/user/account endpoint returns the core account information associated with your API key — the company name, registered country, KYC verification status, and the monthly transaction limit along with how much of that limit you have already consumed in the current calendar month. Use this endpoint to verify account health or to gate features in your application based on KYC status or remaining monthly capacity.

Endpoint

Request Parameters

This endpoint takes no query parameters and no request body. Authentication is the only requirement.

Response Fields

number
required
The numeric response code. 200 indicates a successful response.
string
required
A short message describing the outcome. Returns "SUCCESS" on a successful request.
object
required
An object containing the account details for the authenticated user.

Example Request

Sandbox equivalent

Example Response

The kycPassed field reflects whether your account has completed the Know Your Customer verification process. If kycPassed is false, contact VelaFi support or complete the KYC steps in the merchant portal before attempting to create live orders.
Check monthLimit minus monthUsed before submitting large orders to confirm you have sufficient remaining capacity for the current month. If you need a higher monthly limit, contact VelaFi support.