OPENAPI / COMPONENTS / SCHEMAS

GelatoVerificationSession

stripe_identity_verification_session

VerificationSession 引导你收集并验证用户身份,其中包含验证类型和要执行的[验证检查](https://docs.stripe.com/identity/verification-checks)等信息。系统中的每次验证只应创建一个 VerificationSession。 VerificationSession 在验证流程中会经历[多个状态](https://docs.stripe.com/identity/how-sessions-work)。验证检查完成后,会话中包含用户的已验证数据。 相关指南:[Verification Sessions API](https://docs.stripe.com/identity/verification-sessions)。

object20字段
client_reference_idstring

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

client_secretstring

Stripe.js 用于在应用内[显示验证弹窗](https://docs.stripe.com/js/identity/modal)的短期客户端密钥。该密钥 24 小时后过期且只能使用一次。不要存储或记录它,不要嵌入 URL,也不要暴露给被验证用户以外的任何人。包含该密钥的页面必须启用 TLS。参见[将客户端密钥传递到前端](https://docs.stripe.com/identity/verification-sessions#client-secret)。

createdinteger必填

对象创建时间,以 Unix 纪元起的秒数表示。

idstring必填

对象的唯一标识符。

last_errorstring

如果存在,表示处理验证时最后遇到的错误。

last_verification_reportstring

最近一次 VerificationReport 的 ID。[了解如何访问详细验证结果](https://docs.stripe.com/identity/verification-sessions#results)。

livemodeboolean必填

对象存在于实时模式时为 `true`;存在于测试模式时为 `false`。

metadataobject必填

可附加到对象上的一组[键值对](https://docs.stripe.com/api/metadata),适合以结构化形式保存对象的附加信息。

objectstring必填

表示对象类型的字符串。同一类型的对象具有相同值。

optionsstring

会话验证检查的一组选项。

provided_detailsstring

被验证用户提供的详细信息。这些信息可能会向用户显示。

redactionstring

此 VerificationSession 的编辑状态。会话未被编辑时该字段为 null。

related_customerstring

客户 ID。

related_customer_accountstring

代表客户的 Account ID。

related_persongelato_related_person

statusstring必填

此 VerificationSession 的状态。[了解会话生命周期](https://docs.stripe.com/identity/how-sessions-work)。

typestring必填

要执行的[验证检查](https://docs.stripe.com/identity/verification-checks)类型。

urlstring

用于将用户重定向到 Stripe 并提交身份信息的短期 URL。该 URL 48 小时后过期且只能使用一次。不要存储或记录它,不要通过电子邮件发送,也不要暴露给被验证用户以外的任何人。参见[验证身份证件](https://docs.stripe.com/identity/verify-identity-documents?platform=web&type=redirect)。

verification_flowstring

Dashboard 中验证流程的配置令牌。

verified_outputsstring

用户的已验证数据。