Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks
Sandboxes

List VerificationSessions 

Returns a list of VerificationSessions

Parameters

  • client_reference_idstring

    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.

  • createdobject

    Only return VerificationSessions that were created during the given date interval.

  • statusenum

    Only return VerificationSessions with this status. Learn more about the lifecycle of sessions.

    Possible enum values
    canceled

    The VerificationSession has been invalidated for future submission attempts.

    processing

    The session has been submitted and is being processed. Most verification checks are processed in less than 1 minute.

    requires_input

    Requires user input before processing can continue.

    verified

    Processing of all the verification checks are complete and successfully verified.

More parameters

  • ending_beforestring

  • limitinteger

  • starting_afterstring

Returns

List of VerificationSession objects that match the provided filter criteria.

GET /v1/identity/verification_sessions
curl -G https://api.stripe.com/v1/identity/verification_sessions \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d limit=3
Response
{
  "object": "list",
  "url": "/v1/identity/verification_sessions",
  "has_more": false,
  "data": [
    {
      "id": "vs_1NuNAILkdIwHu7ixh7OtGMLw",
      "object": "identity.verification_session",
      "client_secret": "...",
      "created": 1695680526,
      "last_error": null,
      "last_verification_report": null,
      "livemode": false,
      "metadata": {},
      "options": {
        "document": {
          "require_matching_selfie": true
        }
      },
      "redaction": null,
      "status": "requires_input",
      "type": "document",
      "url": "..."
    }
  ]
}

Cancel a VerificationSession 

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.

Parameters

No parameters.

Returns

Returns the canceled VerificationSession object

POST /v1/identity/verification_sessions/:id/cancel
curl -X POST https://api.stripe.com/v1/identity/verification_sessions/vs_1NuN3kLkdIwHu7ixk5OvTq3b/cancel \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
  "id": "vs_1NuN3kLkdIwHu7ixk5OvTq3b",
  "object": "identity.verification_session",
  "client_secret": null,
  "created": 1695680120,
  "last_error": null,
  "last_verification_report": null,
  "livemode": false,
  "metadata": {},
  "options": {
    "document": {
      "require_matching_selfie": true
    }
  },
  "redaction": null,
  "status": "canceled",
  "type": "document",
  "url": null
}

Redact a VerificationSession 

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.

Parameters

No parameters.

Returns

Returns the redacted VerificationSession object

POST /v1/identity/verification_sessions/:id/redact
curl -X POST https://api.stripe.com/v1/identity/verification_sessions/vs_1NuN3kLkdIwHu7ixk5OvTq3b/redact \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
  "id": "vs_1NuN3kLkdIwHu7ixk5OvTq3b",
  "object": "identity.verification_session",
  "client_secret": null,
  "created": 1695680120,
  "last_error": null,
  "last_verification_report": null,
  "livemode": false,
  "metadata": {},
  "options": {
    "document": {
      "require_matching_selfie": true
    }
  },
  "redaction": {
    "status": "processing"
  },
  "status": "canceled",
  "type": "document",
  "url": null
}

Verification Report 

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 type and options parameters used. You can find the result of each verification check performed in the appropriate sub-resource: document, id_number, selfie.

Each VerificationReport contains a copy of any data collected by the user as well as reference IDs which can be used to access collected images through the FileUpload API. To configure and create VerificationReports, use the VerificationSession API.

Related guide: Accessing verification results.

Endpoints

Crypto Onramp Session 

A Crypto Onramp Session represents your customer’s session as they purchase cryptocurrency through Stripe. Once payment is successful, Stripe will fulfill the delivery of cryptocurrency to your user’s wallet and contain a reference to the crypto transaction ID.

You can create an onramp session on your server and embed the widget on your frontend. Alternatively, you can redirect your users to the standalone hosted onramp.

Related guide: Integrate the onramp

Endpoints