跳转到主要内容
PATCH
更新文档
更新已声明文档的签发数据。type、id 和 isPrimary 不可修改。
  • 更改文档数据会将其已通过(APPROVED)的证明重置为 PENDING:Localpayment 将重新审核这些证明。
  • 如需更改类型或编号,请添加新文档并删除旧文档。
错误使用 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。

示例:

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

docId
string<uuid>
必填

文档的 documentId。

示例:

"e0ea9515-442e-4bc5-bc82-b8d278255c37"

请求体

application/json
issuingCountry
string

ISO 3166-1 alpha-3。

示例:

"BRA"

issueDate
string<date>

YYYY-MM-DD。

示例:

"2024-01-15"

expirationDate
string<date>

YYYY-MM-DD。过去的日期会将该文档标记为 EXPIRED。

示例:

"2034-01-15"

metadata
object

自由格式元数据(替换存储的对象)。

响应

OK。

documentId
string<uuid>

文件标识符(docId)。用于上传和列出证明文件。

示例:

"5ca3e868-2b76-4390-b25a-5d10c0db8516"

entityId
string<uuid>

所有权实体。

示例:

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

type
enum<string>

文件类型。

可用选项:
DNI,
NATIONAL_ID,
DRIVER_LICENSE,
PASSPORT,
CE,
CC,
CUIT,
CUIL,
RFC,
CURP,
CPF,
CNPJ,
RUC,
NIT,
TAX_ID,
ARTICLES_OF_INCORPORATION,
POWER_OF_ATTORNEY,
TAX_CERTIFICATE,
PAYSLIP,
ARCA_REGISTRATION,
PROOF_OF_ADDRESS,
PROOF_OF_FUNDS,
OTHER
示例:

"TAX_ID"

id
string

文件编号与申报一致。

示例:

"00.000.000/0001-00"

issuingCountry
string

按声明提供的发卡方数据。

示例:

"BRA"

issueDate
string<date>

按声明提供的发卡方数据。

示例:

"2024-01-15"

expirationDate
string<date>

按声明提供的发卡方数据。

示例:

"2034-01-15"

isPrimary
boolean

实体识别文件。

示例:

false

status
enum<string>

派生的文档状态:如果 expirationDate 已过,则为 EXPIRED;如果任何有效证明文件被拒绝,则为 REJECTED;如果所有有效证明文件均已批准,则为 VERIFIED;否则为 PENDING。

可用选项:
PENDING,
VERIFIED,
REJECTED,
EXPIRED
示例:

"PENDING"

metadata
object

自由格式元数据。

proofs
object[]

该文件的有效证明(已替换的文件不列出)。

createdAt
string<date-time>
示例:

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

updatedAt
string<date-time>
示例:

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

最后修改于 2026年11月10日