跳转到主要内容
GET
获取证明
返回证明的元数据,以及用于获取文件的短期有效签名 downloadUrl。
  • 示例中缩短了 downloadUrl 的主机、有效期和签名。
  • 对文件的访问会以您访问令牌中的用户身份进行审计。
  • 如果 URL 过期,请再次调用此接口以获取新的 URL。
错误使用带有固定 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"

路径参数

proofId
string<uuid>
必填

证明 ID。

示例:

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

响应

OK。

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;此时无法替换或删除。

示例:

true

downloadUrl
string

签名后的URL有效期为10分钟。请在下载前立即获取;请勿保存。

示例:

"https://files.example.com/<object-path>?expires=600&signature=<redacted>"

最后修改于 2026年11月10日