The VerificationReport object

Identity

Verification Report

Attributes

idstring
Unique identifier for the object.

objectstring
String representing the object’s type. Objects of the same type share the same value.

client_reference_idnullable string
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.

createdtimestamp
Time at which the object was created. Measured in seconds since the Unix epoch.

documentnullable object

Result of the document check for this report.

document.addressnullable object
Address as it appears in the document.
- document.address.citynullable string
  City, district, suburb, town, or village.
- document.address.countrynullable string
  Two-letter country code (ISO 3166-1 alpha-2).
- document.address.line1nullable string
  Address line 1 (e.g., street, PO Box, or company name).
- document.address.line2nullable string
  Address line 2 (e.g., apartment, suite, unit, or building).
- document.address.postal_codenullable string
  ZIP or postal code.
- document.address.statenullable string
  State, county, province, or region.

document.dobnullable objectExpandable
Date of birth as it appears in the document.
- document.dob.daynullable integer
  Numerical day between 1 and 31.
- document.dob.monthnullable integer
  Numerical month between 1 and 12.
- document.dob.yearnullable integer
  The four-digit year.

document.errornullable object

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

document.error.codenullable enum

A short machine-readable string giving the reason for the verification failure.

Possible enum values

document_expired

The provided identity document has expired.

document_type_not_supported

The provided identity document isn’t one of the session’s allowed document types.

document_unverified_other

Stripe couldn’t verify the provided identity document. See list of supported document types.

document.error.reasonnullable string
A human-readable message giving the reason for the failure. These messages can be shown to your users.

document.expiration_datenullable objectExpandable
Expiration date of the document.
- document.expiration_date.daynullable integer
  Numerical day between 1 and 31.
- document.expiration_date.monthnullable integer
  Numerical month between 1 and 12.
- document.expiration_date.yearnullable integer
  The four-digit year.

document.filesnullable array of strings
Array of File ids containing images for this document.

document.first_namenullable string
First name as it appears in the document.

document.issued_datenullable object
Issued date of the document.
- document.issued_date.daynullable integer
  Numerical day between 1 and 31.
- document.issued_date.monthnullable integer
  Numerical month between 1 and 12.
- document.issued_date.yearnullable integer
  The four-digit year.

document.issuing_countrynullable string
Issuing country of the document.

document.last_namenullable string
Last name as it appears in the document.

document.numbernullable stringExpandable
Document ID number.

document.sexnullable enumExpandable
Sex of the person in the document.
Possible enum values
[redacted]
The verification has been redacted.
female
Female
male
Male
unknown
Could not determine the user’s sex.

document.statusenum
Status of this document check.
Possible enum values
unverified
The data being checked was not able to be verified.
verified
The check resulted in a successful verification.

document.typenullable enum
Type of the document.
Possible enum values
driving_license
Drivers license document type.
id_card
ID card document type.
passport
Passport document type.

document.unparsed_place_of_birthnullable stringExpandable
Place of birth as it appears in the document.

document.unparsed_sexnullable stringExpandable
Sex as it appears in the document.

emailnullable object
Result of the email check for this report.
- email.emailnullable string
  Email to be verified.
- email.errornullable object
  Details on the verification error. Present when status is unverified.
  email.error.codenullable enum
  A short machine-readable string giving the reason for the verification failure.
  Possible enum values
  email_unverified_other
  Stripe was unable to verify the provided email address.
  email_verification_declined
  The user was unable to verify the provided email address.
  email.error.reasonnullable string
  A human-readable message giving the reason for the failure. These messages can be shown to your users.
- email.statusenum
  Status of this email check.
  Possible enum values
  unverified
  The data being checked was not able to be verified.
  verified
  The check resulted in a successful verification.

id_numbernullable object

Result of the id number check for this report.

id_number.dobnullable objectExpandable
Date of birth.
- id_number.dob.daynullable integer
  Numerical day between 1 and 31.
- id_number.dob.monthnullable integer
  Numerical month between 1 and 12.
- id_number.dob.yearnullable integer
  The four-digit year.

id_number.errornullable object

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

id_number.error.codenullable enum

A short machine-readable string giving the reason for the verification failure.

Possible enum values

id_number_insufficient_document_data

The provided document didn’t contain enough data to match against the ID number.

id_number_mismatch

The information provided couldn’t be matched against global databases.

id_number_unverified_other

The information provided couldn’t be verified. See list of supported ID numbers.

id_number.error.reasonnullable string
A human-readable message giving the reason for the failure. These messages can be shown to your users.

id_number.first_namenullable string
First name.

id_number.id_numbernullable stringExpandable
ID number. When id_number_type is us_ssn, only the last 4 digits are present.

id_number.id_number_typenullable enum

Type of ID number.

Possible enum values

br_cpf

An individual CPF number from Brazil.

sg_nric

A national registration identity card number from Singapore.

us_ssn

A social security number from the United States. Only the last 4 digits are collected.

id_number.last_namenullable string
Last name.

id_number.statusenum
Status of this id_number check.
Possible enum values
unverified
The data being checked was not able to be verified.
verified
The check resulted in a successful verification.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

optionsnullable object
Configuration options for this report.
- options.documentnullable object
  Configuration options to apply to the document check.
  options.document.allowed_typesnullable array of enums
  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.
  Possible enum values
  driving_license
  Drivers license document type.
  id_card
  ID card document type.
  passport
  Passport document type.
  options.document.require_id_numbernullable boolean
  Collect an ID number and perform an ID number check with the document’s extracted name and date of birth.
  options.document.require_live_capturenullable boolean
  Disable image uploads, identity document images have to be captured using the device’s camera.
  options.document.require_matching_selfienullable boolean
  Capture a face image and perform a selfie check comparing a photo ID and a picture of your user’s face. Learn more.
- options.id_numbernullable object
  Configuration options to apply to the id_number check.

phonenullable object
Result of the phone check for this report.
- phone.errornullable object
  Details on the verification error. Present when status is unverified.
  phone.error.codenullable enum
  A short machine-readable string giving the reason for the verification failure.
  Possible enum values
  phone_unverified_other
  Stripe was unable to verify the provided phone number.
  phone_verification_declined
  The user was unable to verify the provided phone number.
  phone.error.reasonnullable string
  A human-readable message giving the reason for the failure. These messages can be shown to your users.
- phone.phonenullable string
  Phone to be verified.
- phone.statusenum
  Status of this phone check.
  Possible enum values
  unverified
  The data being checked was not able to be verified.
  verified
  The check resulted in a successful verification.

selfienullable object

Result of the selfie check for this report.

selfie.documentnullable string
ID of the File holding the image of the identity document used in this check.

selfie.errornullable object

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

selfie.error.codenullable enum

A short machine-readable string giving the reason for the verification failure.

Possible enum values

selfie_document_missing_photo

The provided identity document didn’t contain a picture of a face.

selfie_face_mismatch

The captured face image didn’t match with the document’s face.

selfie_manipulated

The captured face image was manipulated.

selfie_unverified_other

Stripe couldn’t verify the provided selfie.

selfie.error.reasonnullable string
A human-readable message giving the reason for the failure. These messages can be shown to your users.

selfie.selfienullable string
ID of the File holding the image of the selfie used in this check.

selfie.statusenum
Status of this selfie check.
Possible enum values
unverified
The data being checked was not able to be verified.
verified
The check resulted in a successful verification.

typeenum
Type of report.
Possible enum values
document
Perform a document check.
id_number
Perform an ID number check.
verification_flow
Configuration provided by verification flow

verification_flownullable string
The configuration token of a verification flow from the dashboard.

verification_sessionnullable string
ID of the VerificationSession that created this report.

The VerificationReport object

{
  "id": "vr_1MwBlH2eZvKYlo2C91hOpFMf",
  "object": "identity.verification_report",
  "created": 1681337011,
  "livemode": false,
  "options": {
    "document": {}
  },
  "type": "document",
  "verification_session": "vs_NhaxYCqOE27AqaUTxbIZOnHw",
  "document": {
    "status": "verified",
    "error": null,
    "first_name": "Jenny",
    "last_name": "Rosen",
    "address": {
      "line1": "1234 Main St.",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94111",
      "country": "US"
    },
    "type": "driving_license",
    "files": [
      "file_NhaxRCXT8Iuu8apSuci00UC4",
      "file_NhaxDeWKGAOTc8Uec7UY9Ljj"
    ],
    "expiration_date": {
      "month": 12,
      "day": 1,
      "year": 2025
    },
    "issued_date": {
      "month": 12,
      "day": 1,
      "year": 2020
    },
    "issuing_country": "US"
  }
}

The VerificationReport object

Attributes

idstring

objectstring

client_reference_idnullable string

createdtimestamp

documentnullable object

document.addressnullable object

document.address.citynullable string

document.address.countrynullable string

document.address.line1nullable string

document.address.line2nullable string

document.address.postal_codenullable string

document.address.statenullable string

document.dobnullable objectExpandable

document.dob.daynullable integer

document.dob.monthnullable integer

document.dob.yearnullable integer

document.errornullable object

document.error.codenullable enum

document.error.reasonnullable string

document.expiration_datenullable objectExpandable

document.expiration_date.daynullable integer

document.expiration_date.monthnullable integer

document.expiration_date.yearnullable integer

document.filesnullable array of strings

document.first_namenullable string

document.issued_datenullable object

document.issued_date.daynullable integer

document.issued_date.monthnullable integer

document.issued_date.yearnullable integer

document.issuing_countrynullable string

document.last_namenullable string

document.numbernullable stringExpandable

document.sexnullable enumExpandable

document.statusenum

document.typenullable enum

document.unparsed_place_of_birthnullable stringExpandable

document.unparsed_sexnullable stringExpandable

emailnullable object

email.emailnullable string

email.errornullable object

email.error.codenullable enum

email.error.reasonnullable string

email.statusenum

id_numbernullable object

id_number.dobnullable objectExpandable

id_number.dob.daynullable integer

id_number.dob.monthnullable integer

id_number.dob.yearnullable integer

id_number.errornullable object

id_number.error.codenullable enum

id_number.error.reasonnullable string

id_number.first_namenullable string

id_number.id_numbernullable stringExpandable

id_number.id_number_typenullable enum

id_number.last_namenullable string

id_number.statusenum

livemodeboolean

optionsnullable object

options.documentnullable object

options.document.allowed_typesnullable array of enums

options.document.require_id_numbernullable boolean

options.document.require_live_capturenullable boolean

options.document.require_matching_selfienullable boolean

options.id_numbernullable object

phonenullable object

phone.errornullable object

phone.error.codenullable enum

phone.error.reasonnullable string

phone.phonenullable string

phone.statusenum

selfienullable object

selfie.documentnullable string

selfie.errornullable object

selfie.error.codenullable enum

selfie.error.reasonnullable string

selfie.selfienullable string

selfie.statusenum

typeenum