Stripe::IdentityApi

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

List all verification reports.

@optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param client_reference_id [String?] 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. @optional @param verification_session [String?] Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID. @optional @param _type [String?] Only return VerificationReports of this type @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return VerificationReports that were created during the given date interval. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::GelatoVerificationReportList]

<p>List all verification reports.</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param client_reference_id [String?] 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. @optional @param verification_session [String?] Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID. @optional @param _type [String?] Only return VerificationReports of this type @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return VerificationReports that were created during the given date interval. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

Retrieves an existing VerificationReport

@required @param report [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::IdentityVerificationReport]

<p>Retrieves an existing VerificationReport</p> @required @param report [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

<p>Retrieves an existing VerificationReport</p> @required @param report [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::IdentityVerificationReport, Integer, Hash)] Stripe::IdentityVerificationReport, response status code and response headers

<p>List all verification reports.</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param client_reference_id [String?] 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. @optional @param verification_session [String?] Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID. @optional @param _type [String?] Only return VerificationReports of this type @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return VerificationReports that were created during the given date interval. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::GelatoVerificationReportList, Integer, Hash)] Stripe::GelatoVerificationReportList, response status code and response headers

Returns a list of VerificationSessions

@optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param client_reference_id [String?] 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. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return VerificationSessions that were created during the given date interval. @optional @param status [String?] Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param related_customer [String?] @return [Stripe::GelatoVerificationSessionList]

<p>Returns a list of VerificationSessions</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param client_reference_id [String?] 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. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return VerificationSessions that were created during the given date interval. @optional @param status [String?] Only return VerificationSessions with this status. Learn more about the lifecycle of sessions. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param related_customer [String?] @return nil

Retrieves the details of a VerificationSession that was previously created.

When the session status is requires_input, you can use this method to retrieve a valid client_secret or url to allow re-submission.

@required @param session [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::IdentityVerificationSession]

<p>Retrieves the details of a VerificationSession that was previously created.</p> <p>When the session status is <code>requires_input</code>, you can use this method to retrieve a valid <code>client_secret</code> or <code>url</code> to allow re-submission.</p> @required @param session [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

<p>Retrieves the details of a VerificationSession that was previously created.</p> <p>When the session status is <code>requires_input</code>, you can use this method to retrieve a valid <code>client_secret</code> or <code>url</code> to allow re-submission.</p> @required @param session [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::IdentityVerificationSession, Integer, Hash)] Stripe::IdentityVerificationSession, response status code and response headers

<p>Returns a list of VerificationSessions</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param client_reference_id [String?] 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. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return VerificationSessions that were created during the given date interval. @optional @param status [String?] Only return VerificationSessions with this status. Learn more about the lifecycle of sessions. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param related_customer [String?] @return [Tuple(Stripe::GelatoVerificationSessionList, Integer, Hash)] Stripe::GelatoVerificationSessionList, response status code and response headers

Creates a VerificationSession object.

After the VerificationSession is created, display a verification modal using the session client_secret or send your users to the session’s url.

If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.

Related guide: Verify your users’ identity documents

@optional @param client_reference_id [String?] 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. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @optional @param options [Stripe::SessionOptionsParam?] @optional @param provided_details [Stripe::ProvidedDetailsParam?] @optional @param related_customer [String?] Token referencing a Customer resource. @optional @param return_url [String?] The URL that the user will be redirected to upon completing the verification flow. @optional @param _type [String?] The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`. @optional @param verification_flow [String?] The ID of a Verification Flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows. @return [Stripe::IdentityVerificationSession]

<p>Creates a VerificationSession object.</p> <p>After the VerificationSession is created, display a verification modal using the session <code>client_secret</code> or send your users to the session’s <code>url</code>.</p> <p>If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.</p> <p>Related guide: <a href=&quot;/docs/identity/verify-identity-documents&quot;>Verify your users’ identity documents</a></p> @optional @param client_reference_id [String?] 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. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @optional @param options [Stripe::SessionOptionsParam?] @optional @param provided_details [Stripe::ProvidedDetailsParam?] @optional @param related_customer [String?] Token referencing a Customer resource. @optional @param return_url [String?] The URL that the user will be redirected to upon completing the verification flow. @optional @param _type [String?] The type of verification check to be performed. You must provide a type if not passing verification_flow. @optional @param verification_flow [String?] The ID of a Verification Flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows. @return nil

Updates a VerificationSession object.

When the session status is requires_input, you can use this method to update the verification check and options.

@required @param session [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @optional @param options [Stripe::SessionOptionsParam?] @optional @param provided_details [Stripe::ProvidedDetailsParam?] @optional @param _type [String?] The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. @return [Stripe::IdentityVerificationSession]

<p>Updates a VerificationSession object.</p> <p>When the session status is <code>requires_input</code>, you can use this method to update the verification check and options.</p> @required @param session [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @optional @param options [Stripe::SessionOptionsParam?] @optional @param provided_details [Stripe::ProvidedDetailsParam?] @optional @param _type [String?] The type of verification check to be performed. @return nil

A VerificationSession object can be canceled when it is in requires_input status.

Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.

@required @param session [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::IdentityVerificationSession]

<p>A VerificationSession object can be canceled when it is in <code>requires_input</code> <a href=&quot;/docs/identity/how-sessions-work&quot;>status</a>.</p> <p>Once canceled, future submission attempts are disabled. This cannot be undone. <a href=&quot;/docs/identity/verification-sessions#cancel&quot;>Learn more</a>.</p> @required @param session [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil

<p>A VerificationSession object can be canceled when it is in <code>requires_input</code> <a href=&quot;/docs/identity/how-sessions-work&quot;>status</a>.</p> <p>Once canceled, future submission attempts are disabled. This cannot be undone. <a href=&quot;/docs/identity/verification-sessions#cancel&quot;>Learn more</a>.</p> @required @param session [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::IdentityVerificationSession, Integer, Hash)] Stripe::IdentityVerificationSession, response status code and response headers

Redact a VerificationSession to remove all collected information from Stripe. This will redact the VerificationSession and all objects related to it, including VerificationReports, Events, request logs, etc.

A VerificationSession object can be redacted when it is in requires_input or verified status. Redacting a VerificationSession in requires_action state will automatically cancel it.

The redaction process may take up to four days. When the redaction process is in progress, the VerificationSession’s redaction.status field will be set to processing; when the process is finished, it will change to redacted and an identity.verification_session.redacted event will be emitted.

Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the fields that contain personal data will be replaced by the string [redacted] or a similar placeholder. The metadata field will also be erased. Redacted objects cannot be updated or used for any purpose.

Learn more.

@required @param session [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::IdentityVerificationSession]

<p>Redact a VerificationSession to remove all collected information from Stripe. This will redact the VerificationSession and all objects related to it, including VerificationReports, Events, request logs, etc.</p> <p>A VerificationSession object can be redacted when it is in <code>requires_input</code> or <code>verified</code> <a href=&quot;/docs/identity/how-sessions-work&quot;>status</a>. Redacting a VerificationSession in <code>requires_action</code> state will automatically cancel it.</p> <p>The redaction process may take up to four days. When the redaction process is in progress, the VerificationSession’s <code>redaction.status</code> field will be set to <code>processing</code>; when the process is finished, it will change to <code>redacted</code> and an <code>identity.verification_session.redacted</code> event will be emitted.</p> <p>Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the fields that contain personal data will be replaced by the string <code>[redacted]</code> or a similar placeholder. The <code>metadata</code> field will also be erased. Redacted objects cannot be updated or used for any purpose.</p> <p><a href=&quot;/docs/identity/verification-sessions#redact&quot;>Learn more</a>.</p> @required @param session [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil

<p>Redact a VerificationSession to remove all collected information from Stripe. This will redact the VerificationSession and all objects related to it, including VerificationReports, Events, request logs, etc.</p> <p>A VerificationSession object can be redacted when it is in <code>requires_input</code> or <code>verified</code> <a href=&quot;/docs/identity/how-sessions-work&quot;>status</a>. Redacting a VerificationSession in <code>requires_action</code> state will automatically cancel it.</p> <p>The redaction process may take up to four days. When the redaction process is in progress, the VerificationSession’s <code>redaction.status</code> field will be set to <code>processing</code>; when the process is finished, it will change to <code>redacted</code> and an <code>identity.verification_session.redacted</code> event will be emitted.</p> <p>Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the fields that contain personal data will be replaced by the string <code>[redacted]</code> or a similar placeholder. The <code>metadata</code> field will also be erased. Redacted objects cannot be updated or used for any purpose.</p> <p><a href=&quot;/docs/identity/verification-sessions#redact&quot;>Learn more</a>.</p> @required @param session [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::IdentityVerificationSession, Integer, Hash)] Stripe::IdentityVerificationSession, response status code and response headers

<p>Updates a VerificationSession object.</p> <p>When the session status is <code>requires_input</code>, you can use this method to update the verification check and options.</p> @required @param session [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @optional @param options [Stripe::SessionOptionsParam?] @optional @param provided_details [Stripe::ProvidedDetailsParam?] @optional @param _type [String?] The type of verification check to be performed. @return [Tuple(Stripe::IdentityVerificationSession, Integer, Hash)] Stripe::IdentityVerificationSession, response status code and response headers

<p>Creates a VerificationSession object.</p> <p>After the VerificationSession is created, display a verification modal using the session <code>client_secret</code> or send your users to the session’s <code>url</code>.</p> <p>If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.</p> <p>Related guide: <a href=&quot;/docs/identity/verify-identity-documents&quot;>Verify your users’ identity documents</a></p> @optional @param client_reference_id [String?] 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. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @optional @param options [Stripe::SessionOptionsParam?] @optional @param provided_details [Stripe::ProvidedDetailsParam?] @optional @param related_customer [String?] Token referencing a Customer resource. @optional @param return_url [String?] The URL that the user will be redirected to upon completing the verification flow. @optional @param _type [String?] The type of verification check to be performed. You must provide a type if not passing verification_flow. @optional @param verification_flow [String?] The ID of a Verification Flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows. @return [Tuple(Stripe::IdentityVerificationSession, Integer, Hash)] Stripe::IdentityVerificationSession, response status code and response headers