Stripe: Identity schemas

24 Stripe schemas with complete fields and constraints.

Cancel a Verification Session — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A VerificationSession guides you through the process of collecting and verifying the identities of your users. It contains details about the type of verification, such as what [verification check](/docs/identity/verification-checks) to perform. Only create one VerificationSession for each verification in your system. A VerificationSession transitions through [multiple statuses](/docs/identity/how-sessions-work) throughout its lifetime as it progresses through the verification flow. The VerificationSession contains the user's verified data after verification checks are complete. Related guide: [The Verification Sessions API](https://docs.stripe.com/identity/verification-sessions)
`client_reference_id`	JSON	Optional
`client_reference_id (anyOf 1)`	string	Alternative	A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. Maximum length: 5000
`client_reference_id (anyOf 2)`	null	Alternative
`client_secret`	JSON	Optional
`client_secret (anyOf 1)`	string	Alternative	The short-lived client secret used by Stripe.js to [show a verification modal](https://docs.stripe.com/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://docs.stripe.com/identity/verification-sessions#client-secret) to learn more. Maximum length: 5000
`client_secret (anyOf 2)`	null	Alternative
`created`	JSON	Required within parent
`created (anyOf 1)`	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
`created (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`id`	string	Required within parent	Unique identifier for the object. Maximum length: 5000
`last_error`	JSON	Optional
`last_error (anyOf 1)`	JSON	Alternative	If present, this property tells you the last error encountered when processing the verification.
`last_error (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Cancel a Verification Session — response body — last error value Shows last Verification Session error
`last_error (anyOf 2)`	null	Alternative
`last_verification_report`	JSON	Optional
`last_verification_report (anyOf 1)`	JSON	Alternative	ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://docs.stripe.com/identity/verification-sessions#results)
`last_verification_report (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`last_verification_report (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Retrieve a Verification Report — response body
`last_verification_report (anyOf 2)`	null	Alternative
`livemode`	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`metadata`	object	Required within parent	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field
`metadata.*`	string	Additional keys	Maximum length: 500
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: identity.verification_session
`options`	JSON	Optional
`options (anyOf 1)`	JSON	Alternative	A set of options for the session’s verification checks.
`options (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Cancel a Verification Session — response body — options value document, email, id number, matching, phone
`options (anyOf 2)`	null	Alternative
`provided_details`	JSON	Optional
`provided_details (anyOf 1)`	JSON	Alternative	Details provided about the user being verified. These details may be shown to the user.
`provided_details (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Cancel a Verification Session — response body — provided details value email, phone
`provided_details (anyOf 2)`	null	Alternative
`redaction`	JSON	Optional
`redaction (anyOf 1)`	JSON	Alternative	Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.
`redaction (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Cancel a VerificationSession — response body — redaction / value / status: processing, redacted, validated
`redaction (anyOf 2)`	null	Alternative
`related_customer`	JSON	Optional
`related_customer (anyOf 1)`	string	Alternative	Customer ID Maximum length: 5000
`related_customer (anyOf 2)`	null	Alternative
`related_customer_account`	JSON	Optional
`related_customer_account (anyOf 1)`	string	Alternative	The ID of the Account representing a customer. Maximum length: 5000
`related_customer_account (anyOf 2)`	null	Alternative
`related_person`	Model	Optional	Expand Cancel a Verification Session — response body — related person
`status`	string	Required within parent	Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://docs.stripe.com/identity/how-sessions-work). Known values: canceled, processing, requires_input, verified
`type`	string	Required within parent	The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed. Known values: document, id_number, verification_flow
`url`	JSON	Optional
`url (anyOf 1)`	string	Alternative	The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://docs.stripe.com/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe. Maximum length: 5000
`url (anyOf 2)`	null	Alternative
`verification_flow`	string	Optional	The configuration token of a verification flow from the dashboard. Maximum length: 5000
`verified_outputs`	JSON	Optional
`verified_outputs (anyOf 1)`	JSON	Alternative	The user’s verified data.
`verified_outputs (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Cancel a Verification Session — response body — verified outputs The user’s verified data address, dob, email, first name, id number, id number type, last name, phone, sex, unparsed place of birth, unparsed sex
`verified_outputs (anyOf 2)`	null	Alternative

Referenced models: Cancel a Verification Session — response body — provided details value email, phone, Cancel a Verification Session — response body — related person, Cancel a Verification Session — response body — last error value Shows last Verification Session error, Cancel a Verification Session — response body — options value document, email, id number, matching, phone, Cancel a Verification Session — response body — verified outputs The user’s verified data address, dob, email, first name, id number, id number type, last name, phone, sex, unparsed place of birth, unparsed sex, Retrieve a Verification Report — response body, Cancel a VerificationSession — response body — redaction / value / status: processing, redacted, validated

Cancel a Verification Session — response body — last error value Shows last Verification Session error

Field	Type	Presence	Description and constraints
`$`	object	Root	Shows last VerificationSession error
`code`	JSON	Optional
`code (anyOf 1)`	string	Alternative	A short machine-readable string giving the reason for the verification or user-session failure. Known values: abandoned, consent_declined, country_not_supported, device_not_supported, document_expired, document_type_not_supported, document_unverified_other, email_unverified_other, email_verification_declined, id_number_insufficient_document_data, id_number_mismatch, id_number_unverified_other, phone_unverified_other, phone_verification_declined, selfie_document_missing_photo, selfie_face_mismatch, selfie_manipulated, selfie_unverified_other, under_supported_age
`code (anyOf 2)`	null	Alternative
`reason`	JSON	Optional
`reason (anyOf 1)`	string	Alternative	A message that explains the reason for verification or user-session failure. Maximum length: 5000
`reason (anyOf 2)`	null	Alternative

Cancel a Verification Session — response body — options value document, email, id number, matching, phone

Field	Type	Presence	Description and constraints
`$`	object	Root
`document`	Model	Optional	Expand Retrieve a Verification Report — response body — options document
`email`	Model	Optional	Expand Cancel a Verification Session — response body — options value document, email, id number, matching, phone email
`id_number`	Model	Optional	Expand Create a Payment Method — response body — zip
`matching`	Model	Optional	Expand Cancel a Verification Session — response body — options value document, email, id number, matching, phone matching
`phone`	Model	Optional	Expand Cancel a Verification Session — response body — options value document, email, id number, matching, phone phone

Referenced models: Create a Payment Method — response body — zip, Retrieve a Verification Report — response body — options document, Cancel a Verification Session — response body — options value document, email, id number, matching, phone email, Cancel a Verification Session — response body — options value document, email, id number, matching, phone matching, Cancel a Verification Session — response body — options value document, email, id number, matching, phone phone

Cancel a Verification Session — response body — options value document, email, id number, matching, phone email

Field	Type	Presence	Description and constraints
`$`	object	Root
`require_verification`	boolean	Optional	Request one time password verification of `provided_details.email`.

Cancel a Verification Session — response body — options value document, email, id number, matching, phone matching

Field	Type	Presence	Description and constraints
`$`	object	Root
`dob`	string	Optional	Strictness of the DOB matching policy to apply. Known values: none, similar
`name`	string	Optional	Strictness of the name matching policy to apply. Known values: none, similar

Cancel a Verification Session — response body — options value document, email, id number, matching, phone phone

Field	Type	Presence	Description and constraints
`$`	object	Root
`require_verification`	boolean	Optional	Request one time password verification of `provided_details.phone`.

Cancel a Verification Session — response body — provided details value email, phone

Field	Type	Presence	Description and constraints
`$`	object	Root
`email`	string	Optional	Email of user being verified Maximum length: 5000
`phone`	string	Optional	Phone number of user being verified Maximum length: 5000

Cancel a Verification Session — response body — related person

Field	Type	Presence	Description and constraints
`$`	object	Root
`account`	string	Required within parent	Token referencing the associated Account of the related Person resource. Maximum length: 5000
`person`	string	Required within parent	Token referencing the related Person resource. Maximum length: 5000

Cancel a Verification Session — response body — verified outputs The user’s verified data address, dob, email, first name, id number, id number type, last name, phone, sex, unparsed place of birth, unparsed sex

Field	Type	Presence	Description and constraints
`$`	object	Root
`address`	JSON	Optional
`address (anyOf 1)`	JSON	Alternative	The user's verified address.
`address (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Create a Location — response body — address
`address (anyOf 2)`	null	Alternative
`dob`	JSON	Optional
`dob (anyOf 1)`	JSON	Alternative	The user’s verified date of birth.
`dob (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Retrieve a Verification Report — response body — id number dob Date of birth Point in Time
`dob (anyOf 2)`	null	Alternative
`email`	JSON	Optional
`email (anyOf 1)`	string	Alternative	The user's verified email address Maximum length: 5000
`email (anyOf 2)`	null	Alternative
`first_name`	JSON	Optional
`first_name (anyOf 1)`	string	Alternative	The user's verified first name. Maximum length: 5000
`first_name (anyOf 2)`	null	Alternative
`id_number`	JSON	Optional
`id_number (anyOf 1)`	string	Alternative	The user's verified id number. Maximum length: 5000
`id_number (anyOf 2)`	null	Alternative
`id_number_type`	JSON	Optional
`id_number_type (anyOf 1)`	string	Alternative	The user's verified id number type. Known values: br_cpf, sg_nric, us_ssn
`id_number_type (anyOf 2)`	null	Alternative
`last_name`	JSON	Optional
`last_name (anyOf 1)`	string	Alternative	The user's verified last name. Maximum length: 5000
`last_name (anyOf 2)`	null	Alternative
`phone`	JSON	Optional
`phone (anyOf 1)`	string	Alternative	The user's verified phone number Maximum length: 5000
`phone (anyOf 2)`	null	Alternative
`sex`	JSON	Optional
`sex (anyOf 1)`	string	Alternative	The user's verified sex. Known values: [redacted], female, male, unknown
`sex (anyOf 2)`	null	Alternative
`unparsed_place_of_birth`	JSON	Optional
`unparsed_place_of_birth (anyOf 1)`	string	Alternative	The user's verified place of birth as it appears in the document. Maximum length: 5000
`unparsed_place_of_birth (anyOf 2)`	null	Alternative
`unparsed_sex`	JSON	Optional
`unparsed_sex (anyOf 1)`	string	Alternative	The user's verified sex as it appears in the document. Maximum length: 5000
`unparsed_sex (anyOf 2)`	null	Alternative

Referenced models: Create a Location — response body — address, Retrieve a Verification Report — response body — id number dob Date of birth Point in Time

Cancel a VerificationSession — response body — redaction / value / status: processing, redacted, validated

Field	Type	Presence	Description and constraints
`$`	object	Root
`status`	string	Required within parent	Indicates whether this object and its related objects have been redacted or not. Known values: processing, redacted, validated

Retrieve a Verification Report — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	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://docs.stripe.com/api/files) API. To configure and create VerificationReports, use the [VerificationSession](https://docs.stripe.com/api/identity/verification_sessions) API. Related guide: [Accessing verification results](https://docs.stripe.com/identity/verification-sessions#results).
`client_reference_id`	JSON	Optional
`client_reference_id (anyOf 1)`	string	Alternative	A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. Maximum length: 5000
`client_reference_id (anyOf 2)`	null	Alternative
`created`	JSON	Required within parent
`created (anyOf 1)`	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
`created (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`document`	Model	Optional	Expand Retrieve a Verification Report — response body — document
`email`	Model	Optional	Expand Retrieve a Verification Report — response body — email
`id`	string	Required within parent	Unique identifier for the object. Maximum length: 5000
`id_number`	Model	Optional	Expand Retrieve a Verification Report — response body — id number
`livemode`	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: identity.verification_report
`options`	Model	Optional	Expand Retrieve a Verification Report — response body — options
`phone`	Model	Optional	Expand Retrieve a Verification Report — response body — phone
`selfie`	Model	Optional	Expand Retrieve a Verification Report — response body — selfie
`type`	string	Required within parent	Type of report. Known values: document, id_number, verification_flow
`verification_flow`	string	Optional	The configuration token of a verification flow from the dashboard. Maximum length: 5000
`verification_session`	JSON	Optional
`verification_session (anyOf 1)`	string	Alternative	ID of the VerificationSession that created this report. Maximum length: 5000
`verification_session (anyOf 2)`	null	Alternative

Referenced models: Retrieve a Verification Report — response body — document, Retrieve a Verification Report — response body — email, Retrieve a Verification Report — response body — id number, Retrieve a Verification Report — response body — phone, Retrieve a Verification Report — response body — selfie, Retrieve a Verification Report — response body — options

Retrieve a Verification Report — response body — document

Field	Type	Presence	Description and constraints
`$`	object	Root	Result from a document check
`address`	JSON	Optional
`address (anyOf 1)`	JSON	Alternative	Address as it appears in the document.
`address (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Create a Location — response body — address
`address (anyOf 2)`	null	Alternative
`dob`	JSON	Optional
`dob (anyOf 1)`	JSON	Alternative	Date of birth as it appears in the document.
`dob (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Retrieve a Verification Report — response body — id number dob Date of birth Point in Time
`dob (anyOf 2)`	null	Alternative
`error`	JSON	Optional
`error (anyOf 1)`	JSON	Alternative	Details on the verification error. Present when status is `unverified`.
`error (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Retrieve a Verification Report — response body — document error value code, reason
`error (anyOf 2)`	null	Alternative
`expiration_date`	JSON	Optional
`expiration_date (anyOf 1)`	JSON	Alternative	Expiration date of the document.
`expiration_date (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Retrieve a Verification Report — response body — id number dob Date of birth Point in Time
`expiration_date (anyOf 2)`	null	Alternative
`files`	JSON	Optional
`files (anyOf 1)`	array	Alternative	Array of [File](https://docs.stripe.com/api/files) ids containing images for this document.
`files (anyOf 1)[]`	string	Each item	Maximum length: 5000
`files (anyOf 2)`	null	Alternative
`first_name`	JSON	Optional
`first_name (anyOf 1)`	string	Alternative	First name as it appears in the document. Maximum length: 5000
`first_name (anyOf 2)`	null	Alternative
`issued_date`	JSON	Optional
`issued_date (anyOf 1)`	JSON	Alternative	Issued date of the document.
`issued_date (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Retrieve a Verification Report — response body — id number dob Date of birth Point in Time
`issued_date (anyOf 2)`	null	Alternative
`issuing_country`	JSON	Optional
`issuing_country (anyOf 1)`	string	Alternative	Issuing country of the document. Maximum length: 5000
`issuing_country (anyOf 2)`	null	Alternative
`last_name`	JSON	Optional
`last_name (anyOf 1)`	string	Alternative	Last name as it appears in the document. Maximum length: 5000
`last_name (anyOf 2)`	null	Alternative
`number`	JSON	Optional
`number (anyOf 1)`	string	Alternative	Document ID number. Maximum length: 5000
`number (anyOf 2)`	null	Alternative
`sex`	JSON	Optional
`sex (anyOf 1)`	string	Alternative	Sex of the person in the document. Known values: [redacted], female, male, unknown
`sex (anyOf 2)`	null	Alternative
`status`	string	Required within parent	Status of this `document` check. Known values: unverified, verified
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	Type of the document. Known values: driving_license, id_card, passport
`type (anyOf 2)`	null	Alternative
`unparsed_place_of_birth`	JSON	Optional
`unparsed_place_of_birth (anyOf 1)`	string	Alternative	Place of birth as it appears in the document. Maximum length: 5000
`unparsed_place_of_birth (anyOf 2)`	null	Alternative
`unparsed_sex`	JSON	Optional
`unparsed_sex (anyOf 1)`	string	Alternative	Sex as it appears in the document. Maximum length: 5000
`unparsed_sex (anyOf 2)`	null	Alternative

Referenced models: Create a Location — response body — address, Retrieve a Verification Report — response body — id number dob Date of birth Point in Time, Retrieve a Verification Report — response body — document error value code, reason

Retrieve a Verification Report — response body — document error value code, reason

Field	Type	Presence	Description and constraints
`$`	object	Root
`code`	JSON	Optional
`code (anyOf 1)`	string	Alternative	A short machine-readable string giving the reason for the verification failure. Known values: document_expired, document_type_not_supported, document_unverified_other
`code (anyOf 2)`	null	Alternative
`reason`	JSON	Optional
`reason (anyOf 1)`	string	Alternative	A human-readable message giving the reason for the failure. These messages can be shown to your users. Maximum length: 5000
`reason (anyOf 2)`	null	Alternative

Retrieve a Verification Report — response body — email

Field	Type	Presence	Description and constraints
`$`	object	Root	Result from a email check
`email`	JSON	Optional
`email (anyOf 1)`	string	Alternative	Email to be verified. Maximum length: 5000
`email (anyOf 2)`	null	Alternative
`error`	JSON	Optional
`error (anyOf 1)`	JSON	Alternative	Details on the verification error. Present when status is `unverified`.
`error (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Retrieve a Verification Report — response body — email error value code, reason
`error (anyOf 2)`	null	Alternative
`status`	string	Required within parent	Status of this `email` check. Known values: unverified, verified

Referenced models: Retrieve a Verification Report — response body — email error value code, reason

Retrieve a Verification Report — response body — email error value code, reason

Field	Type	Presence	Description and constraints
`$`	object	Root
`code`	JSON	Optional
`code (anyOf 1)`	string	Alternative	A short machine-readable string giving the reason for the verification failure. Known values: email_unverified_other, email_verification_declined
`code (anyOf 2)`	null	Alternative
`reason`	JSON	Optional
`reason (anyOf 1)`	string	Alternative	A human-readable message giving the reason for the failure. These messages can be shown to your users. Maximum length: 5000
`reason (anyOf 2)`	null	Alternative

Retrieve a Verification Report — response body — id number

Field	Type	Presence	Description and constraints
`$`	object	Root	Result from an id_number check
`dob`	JSON	Optional
`dob (anyOf 1)`	JSON	Alternative	Date of birth.
`dob (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Retrieve a Verification Report — response body — id number dob Date of birth Point in Time
`dob (anyOf 2)`	null	Alternative
`error`	JSON	Optional
`error (anyOf 1)`	JSON	Alternative	Details on the verification error. Present when status is `unverified`.
`error (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Retrieve a Verification Report — response body — id number error value code, reason
`error (anyOf 2)`	null	Alternative
`first_name`	JSON	Optional
`first_name (anyOf 1)`	string	Alternative	First name. Maximum length: 5000
`first_name (anyOf 2)`	null	Alternative
`id_number`	JSON	Optional
`id_number (anyOf 1)`	string	Alternative	ID number. When `id_number_type` is `us_ssn`, only the last 4 digits are present. Maximum length: 5000
`id_number (anyOf 2)`	null	Alternative
`id_number_type`	JSON	Optional
`id_number_type (anyOf 1)`	string	Alternative	Type of ID number. Known values: br_cpf, sg_nric, us_ssn
`id_number_type (anyOf 2)`	null	Alternative
`last_name`	JSON	Optional
`last_name (anyOf 1)`	string	Alternative	Last name. Maximum length: 5000
`last_name (anyOf 2)`	null	Alternative
`status`	string	Required within parent	Status of this `id_number` check. Known values: unverified, verified

Referenced models: Retrieve a Verification Report — response body — id number dob Date of birth Point in Time, Retrieve a Verification Report — response body — id number error value code, reason

Retrieve a Verification Report — response body — id number dob Date of birth Point in Time

Field	Type	Presence	Description and constraints
`$`	object	Root	Point in Time
`day`	JSON	Optional
`day (anyOf 1)`	JSON	Alternative
`day (anyOf 1) (anyOf 1)`	integer	Alternative	Numerical day between 1 and 31.
`day (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`day (anyOf 2)`	null	Alternative
`month`	JSON	Optional
`month (anyOf 1)`	JSON	Alternative
`month (anyOf 1) (anyOf 1)`	integer	Alternative	Numerical month between 1 and 12.
`month (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`month (anyOf 2)`	null	Alternative
`year`	JSON	Optional
`year (anyOf 1)`	JSON	Alternative
`year (anyOf 1) (anyOf 1)`	integer	Alternative	The four-digit year.
`year (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`year (anyOf 2)`	null	Alternative

Retrieve a Verification Report — response body — id number error value code, reason

Field	Type	Presence	Description and constraints
`$`	object	Root
`code`	JSON	Optional
`code (anyOf 1)`	string	Alternative	A short machine-readable string giving the reason for the verification failure. Known values: id_number_insufficient_document_data, id_number_mismatch, id_number_unverified_other
`code (anyOf 2)`	null	Alternative
`reason`	JSON	Optional
`reason (anyOf 1)`	string	Alternative	A human-readable message giving the reason for the failure. These messages can be shown to your users. Maximum length: 5000
`reason (anyOf 2)`	null	Alternative

Retrieve a Verification Report — response body — options

Field	Type	Presence	Description and constraints
`$`	object	Root
`document`	Model	Optional	Expand Retrieve a Verification Report — response body — options document
`id_number`	Model	Optional	Expand Create a Payment Method — response body — zip

Referenced models: Create a Payment Method — response body — zip, Retrieve a Verification Report — response body — options document

Retrieve a Verification Report — response body — options document

Field	Type	Presence	Description and constraints
`$`	object	Root
`allowed_types`	array	Optional	Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
`allowed_types[]`	string	Each item	Known values: driving_license, id_card, passport
`require_id_number`	boolean	Optional	Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
`require_live_capture`	boolean	Optional	Disable image uploads, identity document images have to be captured using the device’s camera.
`require_matching_selfie`	boolean	Optional	Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://docs.stripe.com/identity/selfie).

Retrieve a Verification Report — response body — phone

Field	Type	Presence	Description and constraints
`$`	object	Root	Result from a phone check
`error`	JSON	Optional
`error (anyOf 1)`	JSON	Alternative	Details on the verification error. Present when status is `unverified`.
`error (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Retrieve a Verification Report — response body — phone error value code, reason
`error (anyOf 2)`	null	Alternative
`phone`	JSON	Optional
`phone (anyOf 1)`	string	Alternative	Phone to be verified. Maximum length: 5000
`phone (anyOf 2)`	null	Alternative
`status`	string	Required within parent	Status of this `phone` check. Known values: unverified, verified

Referenced models: Retrieve a Verification Report — response body — phone error value code, reason

Retrieve a Verification Report — response body — phone error value code, reason

Field	Type	Presence	Description and constraints
`$`	object	Root
`code`	JSON	Optional
`code (anyOf 1)`	string	Alternative	A short machine-readable string giving the reason for the verification failure. Known values: phone_unverified_other, phone_verification_declined
`code (anyOf 2)`	null	Alternative
`reason`	JSON	Optional
`reason (anyOf 1)`	string	Alternative	A human-readable message giving the reason for the failure. These messages can be shown to your users. Maximum length: 5000
`reason (anyOf 2)`	null	Alternative

Retrieve a Verification Report — response body — selfie

Field	Type	Presence	Description and constraints
`$`	object	Root	Result from a selfie check
`document`	JSON	Optional
`document (anyOf 1)`	string	Alternative	ID of the [File](https://docs.stripe.com/api/files) holding the image of the identity document used in this check. Maximum length: 5000
`document (anyOf 2)`	null	Alternative
`error`	JSON	Optional
`error (anyOf 1)`	JSON	Alternative	Details on the verification error. Present when status is `unverified`.
`error (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Retrieve a Verification Report — response body — selfie error value code, reason
`error (anyOf 2)`	null	Alternative
`selfie`	JSON	Optional
`selfie (anyOf 1)`	string	Alternative	ID of the [File](https://docs.stripe.com/api/files) holding the image of the selfie used in this check. Maximum length: 5000
`selfie (anyOf 2)`	null	Alternative
`status`	string	Required within parent	Status of this `selfie` check. Known values: unverified, verified

Referenced models: Retrieve a Verification Report — response body — selfie error value code, reason

Retrieve a Verification Report — response body — selfie error value code, reason

Field	Type	Presence	Description and constraints
`$`	object	Root
`code`	JSON	Optional
`code (anyOf 1)`	string	Alternative	A short machine-readable string giving the reason for the verification failure. Known values: selfie_document_missing_photo, selfie_face_mismatch, selfie_manipulated, selfie_unverified_other
`code (anyOf 2)`	null	Alternative
`reason`	JSON	Optional
`reason (anyOf 1)`	string	Alternative	A human-readable message giving the reason for the failure. These messages can be shown to your users. Maximum length: 5000
`reason (anyOf 2)`	null	Alternative

Report an issue with this page