跳转到主要内容
POST
请求验证
告知 Localpayment 该实体的文档上传已完成,并开始对其进行审核。实体状态将从 PENDING_KYC 变为 IN_REVIEW。对于公司,请在其文档、文件和人员均已加载并关联后,针对该公司调用此接口。
  • 无请求体。
  • 仅限在 PENDING_KYC 状态下调用。当实体处于 IN_REVIEW 状态时再次调用,将返回 409 INVALID_STATUS_TRANSITION。
  • 实体至少需要上传一个文件(422 NO_PROOFS_UPLOADED),并具备其最低限度的 KYC 数据(422 INCOMPLETE_KYC_DATA)。
  • 实体处于 IN_REVIEW 状态时会被锁定:您无法编辑其数据、添加或编辑文档、上传或删除文件,也无法关联、更改或终止 UBO(409 ENTITY_IN_REVIEW)。
  • 使用 verify 后,您这一侧的上传流程即告结束:之后无需再轮询该实体的状态。
  • 如果 Localpayment 因需要更正而将实体退回至 PENDING_KYC,请按照 statusReason 中的说明进行修正,然后再次调用此接口。
错误使用 application/problem+json 返回,并带有稳定的 code。完整目录:实体状态与错误代码。

授权

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。

示例:

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

响应

已接受。该实体进入 IN_REVIEW 状态,并被锁定,直至 Localpayment 处理完毕(实体摘录)。

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日