跳转到主要内容
POST
上传证明
上传支持已声明文档的文件(身份证件图像、地址证明 PDF、公司章程)。证明将以 verificationStatus: PENDING 状态创建并加密存储;Localpayment 会对其进行审核。上传所有文件后,请调用 Request Verification。
  • 每个文档的文件数。一个文档可以包含您所需数量的证明:身份证件的正面、背面和自拍照,合同的各页,收据。每个文档 id 的文件数量没有限制。
  • 替换。FRONT、BACK 和 SELFIE 各自只有一个当前文件:再次上传相同类型会替换先前的文件,后者将变为 SUPERSEDED。DOCUMENT 和 OTHER 会累积:每次上传都会新增一个文件(合同的各页、多张收据)。
  • 已批准的文件会被保留。替换已为 APPROVED 的 FRONT、BACK 或 SELFIE 会返回 409 PROOF_APPROVED。
  • 审核期间。当实体处于 IN_REVIEW 状态时,不能上传、替换或删除任何文件(409 ENTITY_IN_REVIEW)。
  • 请检查响应中的 sizeBytes > 0:不含文件部分的 multipart 请求会存储一个空证明。
  • 文件永远不会内联返回;请通过 Get a Proof 或 Download a Proof File 下载。
错误使用 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"

路径参数

docId
string<uuid>
必填

文件所属文档的 documentId。

示例:

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

查询参数

proofType
enum<string>
必填

FRONT、BACK、SELFIE、DOCUMENT、OTHER。

可用选项:
FRONT,
BACK,
SELFIE,
DOCUMENT,
OTHER
示例:

"FRONT"

metadata
string

带有自由格式元数据的 URL 编码 JSON 对象,例如 %7B%22issuer%22%3A%22utility%22%7D。

请求体

multipart/form-data
file
file
必填

JPG、PNG 或 PDF 格式,最大 10 MB。Multipart 部分名为 file。

响应

已创建。

id
string

证明标识符(proofId)。

示例:

"2c4c2f74-7179-4113-83fb-f11dbce9e07d"

documentId
string<uuid>

该文件所佐证的文档。

示例:

"2e16d844-4fa9-4295-9a21-83ec32ef241a"

proofType
enum<string>

FRONT、BACK、SELFIE、DOCUMENT、OTHER。

可用选项:
FRONT,
BACK,
SELFIE,
DOCUMENT,
OTHER
示例:

"FRONT"

fileName
string

已上传文件的元数据。上传后请检查 sizeBytes > 0。

示例:

"id_front.jpg"

mimeType
string

已上传文件的元数据。上传后请检查 sizeBytes > 0。

示例:

"image/jpeg"

sizeBytes
integer

已上传文件的元数据。上传后请检查 sizeBytes > 0。

示例:

102400

verificationStatus
enum<string>

PENDING、IN_REVIEW、APPROVED、REJECTED。由 Localpayment 合规部门设置。

可用选项:
PENDING,
IN_REVIEW,
APPROVED,
REJECTED
示例:

"PENDING"

verifiedBy
string | null

验证结果。拒绝时会填写 verificationReason。

verifiedAt
string<date-time> | null

验证结果。拒绝时会填写 verificationReason。

verificationReason
string | null

验证结果。拒绝时会填写 verificationReason。

uploadedBy
string

您帐户中上传文件的用户(通过访问令牌)和上传时间。

示例:

"12345"

uploadedAt
string<date-time>

您帐户中上传文件的用户(通过访问令牌)和上传时间。

示例:

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

status
enum<string>

证明生命周期:CURRENT(有效)、SUPERSEDED(已被相同 proofType 的新上传证明替换)或 DELETED。与 verificationStatus 无关。

可用选项:
CURRENT,
SUPERSEDED,
DELETED
示例:

"CURRENT"

supersededAt
string<date-time> | null

证明被替换时设置。

supersededBy
string | null

证明被替换时设置。

replacedByProofId
string<uuid> | null

证明被替换时设置。

deletedAt
string<date-time> | null

证明被删除时设置。

deletedBy
string | null

证明被删除时设置。

inVerification
boolean

当证明文件属于正在进行的审核(实体 IN_REVIEW)时为 true;此时无法替换或删除。

示例:

false

最后修改于 2026年11月10日