How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Stripe Identity API

Use Stripe Identity to confirm the identity of global users to prevent fraud, streamline risk operations, and increase trust and safety.

Stripe Identity API is one of 159 APIs that Stripe publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Cancel, Entities, Identity, Redact, and Reports. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 8 operations across 6 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 2023-10-16.

Requests are made against a single base URL, https://api.stripe.com/.

8 operations 6 paths 13 schemas 4 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2023-10-16
Server
https://api.stripe.com/
Authentication
HTTP Basic, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

Stripe Identity API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (auth-scheme) (bearerAuth). By default, every request must be authenticated.

  • basicAuth — Basic HTTP authentication. Allowed headers-- Authorization: Basic | Authorization: Basic
  • bearerAuth — Bearer HTTP authentication. Allowed headers-- Authorization: Bearer

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 4 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Identity 8
GET
/v1/identity/verification_reports
List all verification reports.
GetIdentityVerificationReports 7 params body → 200default
GET
/v1/identity/verification_reports/{report}
Retrieves an existing VerificationReport
GetIdentityVerificationReportsReport 2 params body → 200default
GET
/v1/identity/verification_sessions
Returns a list of VerificationSessions
GetIdentityVerificationSessions 6 params body → 200default
POST
/v1/identity/verification_sessions
Creates a VerificationSession object. After the VerificationSession is created, display a verification modal using the session clientsecret or send your users to the session’s url . If your API key i…
PostIdentityVerificationSessions body → 200default
GET
/v1/identity/verification_sessions/{session}
Retrieves the details of a VerificationSession that was previously created. When the session status is requiresinput , you can use this method to retrieve a valid clientsecret or url to allow re-subm…
GetIdentityVerificationSessionsSession 2 params body → 200default
POST
/v1/identity/verification_sessions/{session}
Updates a VerificationSession object. When the session status is requiresinput , you can use this method to update the verification check and options.
PostIdentityVerificationSessionsSession 1 param body → 200default
POST
/v1/identity/verification_sessions/{session}/cancel
A VerificationSession object can be canceled when it is in requiresinput status . Once canceled, future submission attempts are disabled. This cannot be undone. Learn more .
PostIdentityVerificationSessionsSessionCancel 1 param body → 200default
POST
/v1/identity/verification_sessions/{session}/redact
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 lo…
PostIdentityVerificationSessionsSessionRedact 1 param body → 200default

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are identity.verification_session (14 properties), identity.verification_report (10 properties), PostIdentityVerificationSessionsRequest (5 properties), GelatoVerificationSessionList (4 properties). Each schema is shown below with its type and property counts.

GetIdentityVerificationSessionsSessionRequest
object
error
object
An error response from the Stripe API
1 property 1 required
PostIdentityVerificationSessionsSessionRequest
object
4 properties
identity.verification_report
object
A VerificationReport is the result of an attempt to collect and verify data from a user. The collection of verification checks performed is determined from the…
10 properties 4 required
identity.verification_session
object
A VerificationSession guides you through the process of collecting and verifying the identities of your users. It contains details about the type of verificati…
14 properties 6 required
GelatoVerificationSessionList
object
4 properties 4 required
GelatoVerificationReportList
object
4 properties 4 required
GetIdentityVerificationReportsReportRequest
object
GetIdentityVerificationSessionsRequest
object
GetIdentityVerificationReportsRequest
object
PostIdentityVerificationSessionsSessionRedactRequest
object
1 property
PostIdentityVerificationSessionsSessionCancelRequest
object
1 property
PostIdentityVerificationSessionsRequest
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stripe-identity-api-openapi.yml Raw ↑

Other APIs Stripe publishes across the network.

Stripe Accounts API
Stripe Balance API
Stripe Billing API
Stripe Charges API
Stripe Checkout API
Stripe Climate API
Stripe Country API
Stripe Coupons API
Stripe Credit Notes API
Stripe Customers API
Stripe Disputes API
Stripe Ephemeral Keys API
Where this information came from

This is an independent, third-party profile of Stripe Identity API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.