VerificationReport.php 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. <?php
  2. // File generated from our OpenAPI spec
  3. namespace Stripe\Identity;
  4. /**
  5. * A VerificationReport is the result of an attempt to collect and verify data from
  6. * a user. The collection of verification checks performed is determined from the
  7. * <code>type</code> and <code>options</code> parameters used. You can find the
  8. * result of each verification check performed in the appropriate sub-resource:
  9. * <code>document</code>, <code>id_number</code>, <code>selfie</code>.
  10. *
  11. * Each VerificationReport contains a copy of any data collected by the user as
  12. * well as reference IDs which can be used to access collected images through the
  13. * <a href="https://stripe.com/docs/api/files">FileUpload</a> API. To configure and
  14. * create VerificationReports, use the <a
  15. * href="https://stripe.com/docs/api/identity/verification_sessions">VerificationSession</a>
  16. * API.
  17. *
  18. * Related guides: <a
  19. * href="https://stripe.com/docs/identity/verification-sessions#results">Accessing
  20. * verification results</a>.
  21. *
  22. * @property string $id Unique identifier for the object.
  23. * @property string $object String representing the object's type. Objects of the same type share the same value.
  24. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
  25. * @property null|\Stripe\StripeObject $document Result from a document check
  26. * @property null|\Stripe\StripeObject $id_number Result from an id_number check
  27. * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
  28. * @property \Stripe\StripeObject $options
  29. * @property null|\Stripe\StripeObject $selfie Result from a selfie check
  30. * @property string $type Type of report.
  31. * @property null|string $verification_session ID of the VerificationSession that created this report.
  32. */
  33. class VerificationReport extends \Stripe\ApiResource
  34. {
  35. const OBJECT_NAME = 'identity.verification_report';
  36. use \Stripe\ApiOperations\All;
  37. use \Stripe\ApiOperations\Retrieve;
  38. const TYPE_DOCUMENT = 'document';
  39. const TYPE_ID_NUMBER = 'id_number';
  40. }