> ## Documentation Index
> Fetch the complete documentation index at: https://docs.velafi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 获取账户详情

> 获取已认证用户的基本账户信息，包括公司名称、国家、KYC 状态和每月交易限额。

`GET /v2/user/account` 端点返回与您的 API 密钥关联的核心账户信息——公司名称、注册国家、KYC 验证状态，以及每月交易限额和当前自然月内已使用的额度。使用此端点可以检查账户健康状况，或根据 KYC 状态或剩余月度额度在您的应用中控制功能的开放。

## 端点

| 属性 | 值 |
| - | - |
| **方法** | `GET` |
| **路径** | `/v2/user/account` |
| **认证** | 必需——`X-BH-TOKEN` 请求头 |
| **请求体** | 无 |

## 请求参数

此端点不接受查询参数，也没有请求体。唯一的要求是完成认证。

## 响应字段

**code** `number` *required*

数字响应码。`200` 表示响应成功。

**msg** `string` *required*

描述结果的简短消息。请求成功时返回 `"SUCCESS"`。

**data** `object` *required*

包含已认证用户账户详情的对象。

**data 字段**

**userId** `number` *required*

已认证用户账户的唯一数字标识符。

**country** `string` *required*

账户注册所在国家的完整名称（例如 `"Argentina"`）。

**companyName** `string` *required*

与此账户关联的公司法定名称。

**kycPassed** `boolean` *required*

表示账户是否已成功完成 KYC（了解您的客户）验证流程。在此值为 `true` 之前，通常无法创建订单和进行付款。

**monthLimit** `number` *required*

此账户的每月交易总限额，以 USD 计价。例如，`250000.0` 表示每月上限为 \$250,000。

**monthUsed** `number` *required*

当前自然月内已处理交易的累计 USD 金额。每月初重置为 `0.0`。

## 请求示例

```bash theme={null}
curl --request GET \
  --url https://api.velafi.com/v2/user/account \
  --header "X-BH-TOKEN: your_token"
```

**沙盒环境对应请求**

```bash theme={null}
curl --request GET \
  --url https://api-test.velafi.com/v2/user/account \
  --header "X-BH-TOKEN: your_sandbox_token"
```

## 响应示例

```json theme={null}
{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "userId": 1,
    "country": "Argentina",
    "companyName": "velafi",
    "kycPassed": true,
    "monthLimit": 250000.0,
    "monthUsed": 0.0
  }
}
```

> [!NOTE]
>
> `kycPassed` 字段反映您的账户是否已完成 KYC（了解您的客户）验证流程。如果 `kycPassed` 为 `false`，请在尝试创建正式订单之前联系 VelaFi 支持团队，或在商户门户中完成 KYC 步骤。

> [!TIP]
>
> 在提交大额订单之前，请用 `monthLimit` 减去 `monthUsed`，确认当月剩余额度充足。如需提高每月限额，请联系 [VelaFi 支持团队](mailto:support@velafi.com)。


## Related topics

- [更新日志](https://docs.velafi.com/cn/docs/changelog.md)
- [简介](https://docs.velafi.com/cn/docs/introduction.md)
- [快速开始](https://docs.velafi.com/cn/docs/quickstart.md)
- [创建 API 密钥](https://docs.velafi.com/cn/docs/guides/creating-api-key.md)
- [API 概览](https://docs.velafi.com/cn/api-reference/overview.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.