跳转到主要内容
GET
获取实体
返回完整实体:KYC 数据、已声明的文件及其有效证明、派生状态,以及(对于 COMPANY)UBO 摘要。
  • 示例为一个 COMPANY,关联了两位所有者:uboCount: 2,uboRequirementMet: true。
  • CLOSED 实体仍可通过 id 读取。
  • 非 UUID 的 entityId 将返回 400。
错误使用带有固定 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"

路径参数

entityId
string<uuid>
必填

实体的 internalId。

示例:

"5aced5da-40c1-4bec-85ff-c8cd1bcb4526"

响应

OK。

internalId
string<uuid>

Localpayment 的实体标识符。请在其他所有 Entities endpoint 中使用它。

示例:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

externalId
string

您发送的标识符。

示例:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

type
enum<string>

INDIVIDUAL 或 COMPANY。

可用选项:
INDIVIDUAL,
COMPANY
示例:

"COMPANY"

status
enum<string>

实体状态。请参阅实体状态和错误代码。

可用选项:
PENDING_KYC,
IN_REVIEW,
ACTIVE,
REJECTED,
BLOCKED,
CLOSED
示例:

"PENDING_KYC"

name
string
示例:

"Example Company S.A."

lastname
string | null
birthdate
string<date> | null
gender
string | null
nationality
string | null
birthCountry
string | null
residenceCountry
string | null
occupation
string | null
isPep
boolean
示例:

false

incorporationDate
string<date>
示例:

"2020-01-15"

incorporationCountry
string
示例:

"BRA"

website
string
示例:

"https://www.example.com/new"

示例:

"Jane Doe"

email
string
示例:

"test@example.com"

phone
object
address
object
attributes
object
documentationStatus
enum<string>

NO_FILES、PARTIAL 或 COMPLETE:表示已申报的文件中是没有、部分还是全部至少包含一个文件。它衡量的是文件是否存在,而非是否获批。

可用选项:
NO_FILES,
PARTIAL,
COMPLETE
示例:

"COMPLETE"

document
object

主要文档,包含其 documentId(上传文件时需要)、派生的状态以及当前的 proofs[]。

documents
object[]

其他已声明的文档(主要文档仅出现在 document 中),结构相同。

version
integer

实体版本。等于 ETag 标头;在 PATCH 请求中将其作为 If-Match 发送回。

示例:

3

createdAt
string<date-time>

ISO 8601 UTC 时间戳。

示例:

"2024-01-15T17:18:53Z"

updatedAt
string<date-time>

ISO 8601 UTC 时间戳。

示例:

"2024-01-15T17:19:26Z"

customFieldSchemaVersion
integer

用于验证属性的自定义字段架构版本,或 null。

示例:

9

uboCount
integer

有效 UBO 关联的数量。仅在 COMPANY 的详情中显示;否则为 null。

示例:

2

uboRequirementMet
boolean

当 uboCount 大于等于 1 时为真。仅在 COMPANY 的详细信息中适用。

示例:

true

最后修改于 2026年11月10日