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.
*
* @property string $id Unique identifier for the object.
* @property string $object String representing the object's type. Objects of the same type share the same value.
* @property null|string $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.
* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
* @property null|\Stripe\StripeObject $document Result from a document check
* @property null|\Stripe\StripeObject $email Result from a email check
* @property null|\Stripe\StripeObject $id_number Result from an id_number check
* @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
* @property null|\Stripe\StripeObject $options
* @property null|\Stripe\StripeObject $phone Result from a phone check
* @property null|\Stripe\StripeObject $selfie Result from a selfie check
* @property string $type Type of report.
* @property null|string $verification_flow The configuration token of a Verification Flow from the dashboard.
* @property null|string $verification_session ID of the VerificationSession that created this report.
*/
class VerificationReport extends \Stripe\ApiResource
{
const OBJECT_NAME = 'identity.verification_report';
const TYPE_DOCUMENT = 'document';
const TYPE_ID_NUMBER = 'id_number';
const TYPE_VERIFICATION_FLOW = 'verification_flow';
/**
* List all verification reports.
*
* @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\Collection<\Stripe\Identity\VerificationReport> of ApiResources
*/
public static function all($params = null, $opts = null)
{
$url = static::classUrl();
return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
}
/**
* Retrieves an existing VerificationReport.
*
* @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\Identity\VerificationReport
*/
public static function retrieve($id, $opts = null)
{
$opts = \Stripe\Util\RequestOptions::parse($opts);
$instance = new static($id, $opts);
$instance->refresh();
return $instance;
}
}