Stripe/getIdentityVerificationReports

正在自动加载完整文档…

StripeStripe Identity 身份验证 API

GET/v1/identity/verification_reports

列出验证报告

列出所有验证报告。

创建、查询、更新、取消和编辑 Stripe Identity 验证会话,并查询验证报告;覆盖官方 Identity 路径下全部 8 个 Endpoint,可在网页调试面板中使用当前会话凭据发起单次请求。

请求

operationId
getIdentityVerificationReports
服务器
https://api.stripe.com
认证
bearerAuth

请求参数

client_reference_id

querystring

用于关联该用户的字符串。可填写客户 ID、会话 ID 或类似标识,以便将本次验证与内部系统中的记录对应起来。

created

querystring

仅返回在指定日期区间内创建的 VerificationReport。

ending_before

querystring

分页游标。`ending_before` 是用于确定列表位置的对象 ID。例如,列表请求返回 100 个对象且第一个为 `obj_bar` 时,后续请求可传入 `ending_before=obj_bar` 获取上一页。

expand

queryarray

指定需要在响应中展开的字段。

limit

queryinteger

限制返回对象的数量。取值范围为 1 到 100,默认值为 10。

starting_after

querystring

分页游标。`starting_after` 是用于确定列表位置的对象 ID。例如,列表请求返回 100 个对象且最后一个为 `obj_foo` 时,后续请求可传入 `starting_after=obj_foo` 获取下一页。

type

querystring

仅返回此类型的 VerificationReport。

verification_session

querystring

仅返回由此 VerificationSession ID 创建的 VerificationReport;也允许提供 VerificationIntent ID。

响应

200

objectapplication/json

请求成功。

字段: datahas_moreobjecturl

default

stripe_errorapplication/json

错误响应。

字段: error

{
  "data": {
    "created": 0,
    "document": {
      "files": []
    },
    "email": {
      "status": "unverified"
    },
    "id_number": {
      "id_number_type": "br_cpf",
      "status": "unverified"
    },
    "livemode": false,
    "object": "identity.verification_report"
  },
  "has_more": false,
  "object": "list"
}