Schema2020-08-27object

identity.verification_report

A VerificationReport is the result of an attempt to collect and verify data from a user. The collection of verification checks performed is determined from the `type` and `options` parameters used. You can find the result of each verification check performed in the appropriate sub-resource: `document`, `id_number`, `selfie`. Each VerificationReport contains a copy of any data collected by the user as well as reference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/docs/api/files) API. To configure and create VerificationReports, use the [VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API. Related guides: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results).

Source: openapi/spec3.json
Commit: d70de345383d
Active snapshot: da69df7e6e11

GelatoIdNumberReport

object

Result from an id_number check

dob

optionalnullable

Date of birth.

error

optionalnullable

Details on the verification error. Present when status is `unverified`.

first_name string

optionalnullable

First name.

maxLength:5000

id_number string

optionalnullable

ID number.

maxLength:5000

id_number_type string

optionalnullable

Type of ID number.

Allowed: "br_cpf""sg_nric""us_ssn"

last_name string

optionalnullable

Last name.

maxLength:5000

status string

required

Status of this `id_number` check.

Allowed: "unverified""verified"

Root JSON Schema

{"description":"A VerificationReport is the result of an attempt to collect and verify data from a user.\nThe collection of verification checks performed is determined from the `type` and `options`\nparameters used. You can find the result of each verification check performed in the\nappropriate sub-resource: `document`, `id_number`, `selfie`.\n\nEach VerificationReport contains a copy of any data collected by the user as well as\nreference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/docs/api/files)\nAPI. To configure and create VerificationReports, use the\n[VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API.\n\nRelated guides: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results).","properties":{"created":{"description":"Time at which the object was created. Measured in seconds since the Unix epoch.","format":"unix-time","type":"integer"},"document":{"$ref":"#/components/schemas/gelato_document_report"},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"id_number":{"$ref":"#/components/schemas/gelato_id_number_report"},"livemode":{"description":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","type":"boolean"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["identity.verification_report"],"type":"string"},"options":{"$ref":"#/components/schemas/gelato_verification_report_options"},"selfie":{"$ref":"#/components/schemas/gelato_selfie_report"},"type":{"description":"Type of report.","enum":["document","id_number"],"type":"string","x-stripeBypassValidation":true},"verification_session":{"description":"ID of the VerificationSession that created this report.","maxLength":5000,"nullable":true,"type":"string"}},"required":["created","id","livemode","object","options","type"],"title":"GelatoVerificationReport","type":"object","x-expandableFields":["document","id_number","options","selfie"],"x-resourceId":"identity.verification_report"}