IdentityServiceFactory.php
4 years ago
VerificationReportService.php
2 years ago
VerificationSessionService.php
2 years ago
VerificationSessionService.php
147 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | |
| 5 | namespace Stripe\Service\Identity; |
| 6 | |
| 7 | class VerificationSessionService extends \Stripe\Service\AbstractService |
| 8 | { |
| 9 | /** |
| 10 | * Returns a list of VerificationSessions. |
| 11 | * |
| 12 | * @param null|array $params |
| 13 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 14 | * |
| 15 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 16 | * |
| 17 | * @return \Stripe\Collection<\Stripe\Identity\VerificationSession> |
| 18 | */ |
| 19 | public function all($params = null, $opts = null) |
| 20 | { |
| 21 | return $this->requestCollection('get', '/v1/identity/verification_sessions', $params, $opts); |
| 22 | } |
| 23 | |
| 24 | /** |
| 25 | * A VerificationSession object can be canceled when it is in |
| 26 | * <code>requires_input</code> <a |
| 27 | * href="/docs/identity/how-sessions-work">status</a>. |
| 28 | * |
| 29 | * Once canceled, future submission attempts are disabled. This cannot be undone. |
| 30 | * <a href="/docs/identity/verification-sessions#cancel">Learn more</a>. |
| 31 | * |
| 32 | * @param string $id |
| 33 | * @param null|array $params |
| 34 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 35 | * |
| 36 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 37 | * |
| 38 | * @return \Stripe\Identity\VerificationSession |
| 39 | */ |
| 40 | public function cancel($id, $params = null, $opts = null) |
| 41 | { |
| 42 | return $this->request('post', $this->buildPath('/v1/identity/verification_sessions/%s/cancel', $id), $params, $opts); |
| 43 | } |
| 44 | |
| 45 | /** |
| 46 | * Creates a VerificationSession object. |
| 47 | * |
| 48 | * After the VerificationSession is created, display a verification modal using the |
| 49 | * session <code>client_secret</code> or send your users to the session’s |
| 50 | * <code>url</code>. |
| 51 | * |
| 52 | * If your API key is in test mode, verification checks won’t actually process, |
| 53 | * though everything else will occur as if in live mode. |
| 54 | * |
| 55 | * Related guide: <a href="/docs/identity/verify-identity-documents">Verify your |
| 56 | * users’ identity documents</a>. |
| 57 | * |
| 58 | * @param null|array $params |
| 59 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 60 | * |
| 61 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 62 | * |
| 63 | * @return \Stripe\Identity\VerificationSession |
| 64 | */ |
| 65 | public function create($params = null, $opts = null) |
| 66 | { |
| 67 | return $this->request('post', '/v1/identity/verification_sessions', $params, $opts); |
| 68 | } |
| 69 | |
| 70 | /** |
| 71 | * Redact a VerificationSession to remove all collected information from Stripe. |
| 72 | * This will redact the VerificationSession and all objects related to it, |
| 73 | * including VerificationReports, Events, request logs, etc. |
| 74 | * |
| 75 | * A VerificationSession object can be redacted when it is in |
| 76 | * <code>requires_input</code> or <code>verified</code> <a |
| 77 | * href="/docs/identity/how-sessions-work">status</a>. Redacting a |
| 78 | * VerificationSession in <code>requires_action</code> state will automatically |
| 79 | * cancel it. |
| 80 | * |
| 81 | * The redaction process may take up to four days. When the redaction process is in |
| 82 | * progress, the VerificationSession’s <code>redaction.status</code> field will be |
| 83 | * set to <code>processing</code>; when the process is finished, it will change to |
| 84 | * <code>redacted</code> and an <code>identity.verification_session.redacted</code> |
| 85 | * event will be emitted. |
| 86 | * |
| 87 | * Redaction is irreversible. Redacted objects are still accessible in the Stripe |
| 88 | * API, but all the fields that contain personal data will be replaced by the |
| 89 | * string <code>[redacted]</code> or a similar placeholder. The |
| 90 | * <code>metadata</code> field will also be erased. Redacted objects cannot be |
| 91 | * updated or used for any purpose. |
| 92 | * |
| 93 | * <a href="/docs/identity/verification-sessions#redact">Learn more</a>. |
| 94 | * |
| 95 | * @param string $id |
| 96 | * @param null|array $params |
| 97 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 98 | * |
| 99 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 100 | * |
| 101 | * @return \Stripe\Identity\VerificationSession |
| 102 | */ |
| 103 | public function redact($id, $params = null, $opts = null) |
| 104 | { |
| 105 | return $this->request('post', $this->buildPath('/v1/identity/verification_sessions/%s/redact', $id), $params, $opts); |
| 106 | } |
| 107 | |
| 108 | /** |
| 109 | * Retrieves the details of a VerificationSession that was previously created. |
| 110 | * |
| 111 | * When the session status is <code>requires_input</code>, you can use this method |
| 112 | * to retrieve a valid <code>client_secret</code> or <code>url</code> to allow |
| 113 | * re-submission. |
| 114 | * |
| 115 | * @param string $id |
| 116 | * @param null|array $params |
| 117 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 118 | * |
| 119 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 120 | * |
| 121 | * @return \Stripe\Identity\VerificationSession |
| 122 | */ |
| 123 | public function retrieve($id, $params = null, $opts = null) |
| 124 | { |
| 125 | return $this->request('get', $this->buildPath('/v1/identity/verification_sessions/%s', $id), $params, $opts); |
| 126 | } |
| 127 | |
| 128 | /** |
| 129 | * Updates a VerificationSession object. |
| 130 | * |
| 131 | * When the session status is <code>requires_input</code>, you can use this method |
| 132 | * to update the verification check and options. |
| 133 | * |
| 134 | * @param string $id |
| 135 | * @param null|array $params |
| 136 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 137 | * |
| 138 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 139 | * |
| 140 | * @return \Stripe\Identity\VerificationSession |
| 141 | */ |
| 142 | public function update($id, $params = null, $opts = null) |
| 143 | { |
| 144 | return $this->request('post', $this->buildPath('/v1/identity/verification_sessions/%s', $id), $params, $opts); |
| 145 | } |
| 146 | } |
| 147 |