跳转到主要内容
GET
列出实体
返回您的实体的分页列表。除非 includeClosed=true,否则不包括已关闭的实体。
  • 筛选条件中的无效枚举值将返回 400 VALIDATION_ERROR。
  • 不支持按名称筛选。
错误使用带有固定 code 的 application/problem+json。完整目录:实体状态和错误代码。

授权

Authorization
string
header
必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

请求头

Authorization
string
必填

用于身份验证的 Bearer 访问令牌。该令牌可从获取访问令牌或刷新访问令牌endpoint 获取。系统将据此识别您的商户账户和执行操作的用户。

示例:

"Bearer <your_access_token>"

X-Correlation-ID
string

跟踪标识符(UUID)。会在响应中原样返回;如未提供,则由 Localpayment 生成。

示例:

"0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10"

查询参数

type
enum<string>

INDIVIDUAL 或 COMPANY。

可用选项:
INDIVIDUAL,
COMPANY
status
enum<string>

实体状态。

可用选项:
PENDING_KYC,
IN_REVIEW,
ACTIVE,
REJECTED,
BLOCKED,
CLOSED
externalId
string

与您的标识符完全匹配。

documentId
string

任何已申报文件的单据编号(完全匹配)。

documentationStatus
enum<string>

NO_FILES、PARTIAL、COMPLETE。

可用选项:
NO_FILES,
PARTIAL,
COMPLETE
createdFrom
string<date-time>

ISO 8601,包含边界值。

createdTo
string<date-time>

ISO 8601,包含边界值。

includeClosed
boolean

包含已关闭的实体。默认值为 false。

pageIndex
integer

从零开始的页面。默认值为 0。

pageSize
integer

默认值为 20,最大值为 200(大于此值将被限制)。

响应

OK。

pageIndex
integer

分页数据。

示例:

0

pageSize
integer

分页数据。

示例:

20

totalElements
integer

分页数据。

示例:

1

totalPages
integer

分页数据。

示例:

1

content
object[]

实体,结构与“获取实体”相同。列表中 uboCount 和 uboRequirementMet 为空。

最后修改于 2026年11月10日