Stripe.Resources.Identity.VerificationReport (tiger_stripe v0.3.0)

GelatoVerificationReport

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 API. To configure and create VerificationReports, use the VerificationSession API.

Related guide: Accessing verification results.

Summary

Types

document()

document_dob()

document_error()

document_expiration_date()

document_issued_date()

email()

email_error()

id_number()

id_number_dob()

id_number_error()

options()

options_document()

phone()

phone_error()

selfie()

selfie_error()

t()

Functions

expandable_fields()

object_name()

Types

document()

@type document() :: %{
  optional(:address) => Stripe.Resources.Address.t() | nil,
  optional(:dob) => document_dob() | nil,
  optional(:error) => document_error() | nil,
  optional(:expiration_date) => document_expiration_date() | nil,
  optional(:files) => [String.t()] | nil,
  optional(:first_name) => String.t() | nil,
  optional(:issued_date) => document_issued_date() | nil,
  optional(:issuing_country) => String.t() | nil,
  optional(:last_name) => String.t() | nil,
  optional(:number) => String.t() | nil,
  optional(:sex) => String.t() | nil,
  optional(:status) => String.t() | nil,
  optional(:type) => String.t() | nil,
  optional(:unparsed_place_of_birth) => String.t() | nil,
  optional(:unparsed_sex) => String.t() | nil,
  optional(String.t()) => term()
}

address - Address as it appears in the document. Nullable.
dob - Date of birth as it appears in the document. Nullable.
error - Details on the verification error. Present when status is unverified. Nullable.
expiration_date - Expiration date of the document. Nullable.
files - Array of File ids containing images for this document. Nullable.
first_name - First name as it appears in the document. Max length: 5000. Nullable.
issued_date - Issued date of the document. Nullable.
issuing_country - Issuing country of the document. Max length: 5000. Nullable.
last_name - Last name as it appears in the document. Max length: 5000. Nullable.
number - Document ID number. Max length: 5000. Nullable.
sex - Sex of the person in the document. Possible values: [redacted], female, male, unknown. Nullable.
status - Status of this document check. Possible values: unverified, verified.
type - Type of the document. Possible values: driving_license, id_card, passport. Nullable.
unparsed_place_of_birth - Place of birth as it appears in the document. Max length: 5000. Nullable.
unparsed_sex - Sex as it appears in the document. Max length: 5000. Nullable.

document_dob()

@type document_dob() :: %{
  optional(:day) => integer() | nil,
  optional(:month) => integer() | nil,
  optional(:year) => integer() | nil,
  optional(String.t()) => term()
}

day - Numerical day between 1 and 31. Nullable.
month - Numerical month between 1 and 12. Nullable.
year - The four-digit year. Nullable.

document_error()

@type document_error() :: %{
  optional(:code) => String.t() | nil,
  optional(:reason) => String.t() | nil,
  optional(String.t()) => term()
}

code - A short machine-readable string giving the reason for the verification failure. Possible values: document_expired, document_type_not_supported, document_unverified_other. Nullable.
reason - A human-readable message giving the reason for the failure. These messages can be shown to your users. Max length: 5000. Nullable.

document_expiration_date()

@type document_expiration_date() :: %{
  optional(:day) => integer() | nil,
  optional(:month) => integer() | nil,
  optional(:year) => integer() | nil,
  optional(String.t()) => term()
}

day - Numerical day between 1 and 31. Nullable.
month - Numerical month between 1 and 12. Nullable.
year - The four-digit year. Nullable.

document_issued_date()

@type document_issued_date() :: %{
  optional(:day) => integer() | nil,
  optional(:month) => integer() | nil,
  optional(:year) => integer() | nil,
  optional(String.t()) => term()
}

day - Numerical day between 1 and 31. Nullable.
month - Numerical month between 1 and 12. Nullable.
year - The four-digit year. Nullable.

email()

@type email() :: %{
  optional(:email) => String.t() | nil,
  optional(:error) => email_error() | nil,
  optional(:status) => String.t() | nil,
  optional(String.t()) => term()
}

email - Email to be verified. Max length: 5000. Nullable.
error - Details on the verification error. Present when status is unverified. Nullable.
status - Status of this email check. Possible values: unverified, verified.

email_error()

@type email_error() :: %{
  optional(:code) => String.t() | nil,
  optional(:reason) => String.t() | nil,
  optional(String.t()) => term()
}

code - A short machine-readable string giving the reason for the verification failure. Possible values: email_unverified_other, email_verification_declined. Nullable.
reason - A human-readable message giving the reason for the failure. These messages can be shown to your users. Max length: 5000. Nullable.

id_number()

@type id_number() :: %{
  optional(:dob) => id_number_dob() | nil,
  optional(:error) => id_number_error() | nil,
  optional(:first_name) => String.t() | nil,
  optional(:id_number) => String.t() | nil,
  optional(:id_number_type) => String.t() | nil,
  optional(:last_name) => String.t() | nil,
  optional(:status) => String.t() | nil,
  optional(String.t()) => term()
}

dob - Date of birth. Nullable.
error - Details on the verification error. Present when status is unverified. Nullable.
first_name - First name. Max length: 5000. Nullable.
id_number - ID number. When id_number_type is us_ssn, only the last 4 digits are present. Max length: 5000. Nullable.
id_number_type - Type of ID number. Possible values: br_cpf, sg_nric, us_ssn. Nullable.
last_name - Last name. Max length: 5000. Nullable.
status - Status of this id_number check. Possible values: unverified, verified.

id_number_dob()

@type id_number_dob() :: %{
  optional(:day) => integer() | nil,
  optional(:month) => integer() | nil,
  optional(:year) => integer() | nil,
  optional(String.t()) => term()
}

day - Numerical day between 1 and 31. Nullable.
month - Numerical month between 1 and 12. Nullable.
year - The four-digit year. Nullable.

id_number_error()

@type id_number_error() :: %{
  optional(:code) => String.t() | nil,
  optional(:reason) => String.t() | nil,
  optional(String.t()) => term()
}

code - A short machine-readable string giving the reason for the verification failure. Possible values: id_number_insufficient_document_data, id_number_mismatch, id_number_unverified_other. Nullable.
reason - A human-readable message giving the reason for the failure. These messages can be shown to your users. Max length: 5000. Nullable.

options()

@type options() :: %{
  optional(:document) => options_document() | nil,
  optional(:id_number) => map() | nil,
  optional(String.t()) => term()
}

document
id_number

options_document()

@type options_document() :: %{
  optional(:allowed_types) => [String.t()] | nil,
  optional(:require_id_number) => boolean() | nil,
  optional(:require_live_capture) => boolean() | nil,
  optional(:require_matching_selfie) => boolean() | nil,
  optional(String.t()) => term()
}

allowed_types - 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.
require_id_number - Collect an ID number and perform an ID number check with the document’s extracted name and date of birth.
require_live_capture - Disable image uploads, identity document images have to be captured using the device’s camera.
require_matching_selfie - Capture a face image and perform a selfie check comparing a photo ID and a picture of your user’s face. Learn more.

phone()

@type phone() :: %{
  optional(:error) => phone_error() | nil,
  optional(:phone) => String.t() | nil,
  optional(:status) => String.t() | nil,
  optional(String.t()) => term()
}

error - Details on the verification error. Present when status is unverified. Nullable.
phone - Phone to be verified. Max length: 5000. Nullable.
status - Status of this phone check. Possible values: unverified, verified.

phone_error()

@type phone_error() :: %{
  optional(:code) => String.t() | nil,
  optional(:reason) => String.t() | nil,
  optional(String.t()) => term()
}

code - A short machine-readable string giving the reason for the verification failure. Possible values: phone_unverified_other, phone_verification_declined. Nullable.
reason - A human-readable message giving the reason for the failure. These messages can be shown to your users. Max length: 5000. Nullable.

selfie()

@type selfie() :: %{
  optional(:document) => String.t() | nil,
  optional(:error) => selfie_error() | nil,
  optional(:selfie) => String.t() | nil,
  optional(:status) => String.t() | nil,
  optional(String.t()) => term()
}

document - ID of the File holding the image of the identity document used in this check. Max length: 5000. Nullable.
error - Details on the verification error. Present when status is unverified. Nullable.
selfie - ID of the File holding the image of the selfie used in this check. Max length: 5000. Nullable.
status - Status of this selfie check. Possible values: unverified, verified.

selfie_error()

@type selfie_error() :: %{
  optional(:code) => String.t() | nil,
  optional(:reason) => String.t() | nil,
  optional(String.t()) => term()
}

code - A short machine-readable string giving the reason for the verification failure. Possible values: selfie_document_missing_photo, selfie_face_mismatch, selfie_manipulated, selfie_unverified_other. Nullable.
reason - A human-readable message giving the reason for the failure. These messages can be shown to your users. Max length: 5000. Nullable.

t()

@type t() :: %Stripe.Resources.Identity.VerificationReport{
  client_reference_id: String.t(),
  created: integer(),
  document: document() | nil,
  email: email() | nil,
  id: String.t(),
  id_number: id_number() | nil,
  livemode: boolean(),
  object: String.t(),
  options: options() | nil,
  phone: phone() | nil,
  selfie: selfie() | nil,
  type: String.t(),
  verification_flow: String.t() | nil,
  verification_session: String.t()
}

client_reference_id - 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. Max length: 5000. Nullable.
created - Time at which the object was created. Measured in seconds since the Unix epoch. Format: Unix timestamp.
document - Expandable.
email - Expandable.
id - Unique identifier for the object. Max length: 5000.
id_number - Expandable.
livemode - Has the value true if the object exists in live mode or the value false if the object exists in test mode.
object - String representing the object's type. Objects of the same type share the same value. Possible values: identity.verification_report.
options - Expandable.
phone - Expandable.
selfie - Expandable.
type - Type of report. Possible values: document, id_number, verification_flow.
verification_flow - The configuration token of a verification flow from the dashboard. Max length: 5000.
verification_session - ID of the VerificationSession that created this report. Max length: 5000. Nullable.

Functions

expandable_fields()

object_name()