跳转到主要内容
POST
添加文档
为现有实体声明一份附加文件:地址证明、公司章程、授权委托书或任何其他证明文件。文件随后通过“上传证明文件”上传。
  • 主文件始终是创建实体时发送的文件。在此处发送 isPrimary: true 将返回 400 VALIDATION_ERROR。
  • 实体不得处于 IN_REVIEW、REJECTED、BLOCKED 或 CLOSED 状态。
错误使用 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"

请求体

application/json
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
示例:

"PROOF_OF_ADDRESS"

id
string
必填

文件编号,1 至 30 个字符。在您的商户中,此编号必须唯一。对于没有官方编号的凭证,请使用您自己的参考编号(例如 POA-0001)。

示例:

"POA-0001"

issuingCountry
string

ISO 3166-1 alpha-3。

示例:

"BRA"

issueDate
string<date>

YYYY-MM-DD。

示例:

"2024-01-15"

expirationDate
string<date>

YYYY-MM-DD。

示例:

"2034-01-15"

metadata
object

自由格式元数据。

响应

已创建。

documentId
string<uuid>

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

示例:

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

entityId
string<uuid>

所有权实体。

示例:

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

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
示例:

"PROOF_OF_ADDRESS"

id
string

文件编号与申报一致。

示例:

"POA-0001"

issuingCountry
string

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

示例:

"BRA"

issueDate
string<date> | null

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

expirationDate
string<date> | null

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

isPrimary
boolean

实体识别文件。

示例:

false

status
enum<string>

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

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

"PENDING"

metadata
object | null

自由格式元数据。

proofs
object[]

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

createdAt
string<date-time>
示例:

"2024-01-15T17:03:11Z"

updatedAt
string<date-time>
示例:

"2024-01-15T17:03:11Z"

最后修改于 2026年11月10日