{ "opencollection": "1.0.0", "info": { "name": "Stripe Accounts Account Verification API", "version": "2023-10-16" }, "items": [ { "info": { "name": "Verification", "type": "folder" }, "items": [ { "info": { "name": "Stripe Get Identity Verification Reports", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/identity/verification_reports", "params": [ { "name": "created", "value": "", "type": "query" }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." }, { "name": "type", "value": "", "type": "query", "description": "Only return VerificationReports of this type" }, { "name": "verification_session", "value": "", "type": "query", "description": "Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

List all verification reports.

" }, { "info": { "name": "Stripe Get Identity Verification Reports Report", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/identity/verification_reports/:report", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "report", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Retrieves an existing VerificationReport

" }, { "info": { "name": "Stripe Get Identity Verification Sessions", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/identity/verification_sessions", "params": [ { "name": "created", "value": "", "type": "query" }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." }, { "name": "status", "value": "", "type": "query", "description": "Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work)." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Returns a list of VerificationSessions

" }, { "info": { "name": "Stripe Post Identity Verification Sessions", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/identity/verification_sessions", "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Creates a VerificationSession object.

\n\n

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

\n\n

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

\n\n

Related guide: Verify your users’ identity documents

" }, { "info": { "name": "Stripe Get Identity Verification Sessions Session", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/identity/verification_sessions/:session", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "session", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Retrieves the details of a VerificationSession that was previously created.

\n\n

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

" }, { "info": { "name": "Stripe Post Identity Verification Sessions Session", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/identity/verification_sessions/:session", "params": [ { "name": "session", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Updates a VerificationSession object.

\n\n

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

" }, { "info": { "name": "Stripe Post Identity Verification Sessions Session Cancel", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/identity/verification_sessions/:session/cancel", "params": [ { "name": "session", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

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

\n\n

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

" }, { "info": { "name": "Stripe Post Identity Verification Sessions Session Redact", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/identity/verification_sessions/:session/redact", "params": [ { "name": "session", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

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

\n\n

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

\n\n

The re" } ] } ], "bundled": true }