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