Stripe: List Verification Reports

← Identity operations · Get started

Operation stripe.getidentityverificationreports

Provider route: GET /v1/identity/verification_reports. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";

async function execute(input: Parameters<StripeIntegration["identity"]["getIdentityVerificationReports"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.identity.getIdentityVerificationReports(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.identity.get_identity_verification_reports(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.client_reference_id	string	Optional	Maximum length: 5000
query.created	JSON	Optional
query.created (anyOf 1)	object	Alternative
query.created (anyOf 1).gt	integer	Optional
query.created (anyOf 1).gte	integer	Optional
query.created (anyOf 1).lt	integer	Optional
query.created (anyOf 1).lte	integer	Optional
query.created (anyOf 2)	integer	Alternative
query.ending_before	string	Optional	Maximum length: 5000
query.expand	array	Optional
query.expand[]	string	Each item	Maximum length: 5000
query.limit	integer	Optional
query.starting_after	string	Optional	Maximum length: 5000
query.type	string	Optional	One of: document, id_number
query.verification_session	string	Optional	Maximum length: 5000

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	object	Root
data	array	Required within parent
data[]	Model	Each item	Expand Retrieve a Verification Report — response body
has_more	boolean	Required within parent	True if this list has another page of items after this one that can be fetched.
object	string	Required within parent	String representing the object’s type. Objects of the same type share the same value. Always has the value `list`. Known values: list
url	string	Required within parent	The URL where this list can be accessed. Maximum length: 5000 Pattern: ^/v1/identity/verification_reports

Referenced models: Retrieve a Verification Report — response body

Schemas

12 more schemas are linked from the tables above, on the schema pages.

Retrieve a Verification Report — response body

Field	Type	Presence	Description and constraints
$	object	Root	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](https://docs.stripe.com/api/files) API. To configure and create VerificationReports, use the [VerificationSession](https://docs.stripe.com/api/identity/verification_sessions) API. Related guide: [Accessing verification results](https://docs.stripe.com/identity/verification-sessions#results).
client_reference_id	JSON	Optional
client_reference_id (anyOf 1)	string	Alternative	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. Maximum length: 5000
client_reference_id (anyOf 2)	null	Alternative
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
document	Model	Optional	Expand Retrieve a Verification Report — response body — document
email	Model	Optional	Expand Retrieve a Verification Report — response body — email
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
id_number	Model	Optional	Expand Retrieve a Verification Report — response body — id number
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: identity.verification_report
options	Model	Optional	Expand Retrieve a Verification Report — response body — options
phone	Model	Optional	Expand Retrieve a Verification Report — response body — phone
selfie	Model	Optional	Expand Retrieve a Verification Report — response body — selfie
type	string	Required within parent	Type of report. Known values: document, id_number, verification_flow
verification_flow	string	Optional	The configuration token of a verification flow from the dashboard. Maximum length: 5000
verification_session	JSON	Optional
verification_session (anyOf 1)	string	Alternative	ID of the VerificationSession that created this report. Maximum length: 5000
verification_session (anyOf 2)	null	Alternative

Referenced models: Retrieve a Verification Report — response body — document, Retrieve a Verification Report — response body — email, Retrieve a Verification Report — response body — id number, Retrieve a Verification Report — response body — phone, Retrieve a Verification Report — response body — selfie, Retrieve a Verification Report — response body — options

Retrieve a Verification Report — response body — document

Field	Type	Presence	Description and constraints
$	object	Root	Result from a document check
address	JSON	Optional
address (anyOf 1)	JSON	Alternative	Address as it appears in the document.
address (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a Location — response body — address
address (anyOf 2)	null	Alternative
dob	JSON	Optional
dob (anyOf 1)	JSON	Alternative	Date of birth as it appears in the document.
dob (anyOf 1) (anyOf 1)	Model	Alternative	Expand Retrieve a Verification Report — response body — id number dob Date of birth Point in Time
dob (anyOf 2)	null	Alternative
error	JSON	Optional
error (anyOf 1)	JSON	Alternative	Details on the verification error. Present when status is `unverified`.
error (anyOf 1) (anyOf 1)	Model	Alternative	Expand Retrieve a Verification Report — response body — document error value code, reason
error (anyOf 2)	null	Alternative
expiration_date	JSON	Optional
expiration_date (anyOf 1)	JSON	Alternative	Expiration date of the document.
expiration_date (anyOf 1) (anyOf 1)	Model	Alternative	Expand Retrieve a Verification Report — response body — id number dob Date of birth Point in Time
expiration_date (anyOf 2)	null	Alternative
files	JSON	Optional
files (anyOf 1)	array	Alternative	Array of [File](https://docs.stripe.com/api/files) ids containing images for this document.
files (anyOf 1)[]	string	Each item	Maximum length: 5000
files (anyOf 2)	null	Alternative
first_name	JSON	Optional
first_name (anyOf 1)	string	Alternative	First name as it appears in the document. Maximum length: 5000
first_name (anyOf 2)	null	Alternative
issued_date	JSON	Optional
issued_date (anyOf 1)	JSON	Alternative	Issued date of the document.
issued_date (anyOf 1) (anyOf 1)	Model	Alternative	Expand Retrieve a Verification Report — response body — id number dob Date of birth Point in Time
issued_date (anyOf 2)	null	Alternative
issuing_country	JSON	Optional
issuing_country (anyOf 1)	string	Alternative	Issuing country of the document. Maximum length: 5000
issuing_country (anyOf 2)	null	Alternative
last_name	JSON	Optional
last_name (anyOf 1)	string	Alternative	Last name as it appears in the document. Maximum length: 5000
last_name (anyOf 2)	null	Alternative
number	JSON	Optional
number (anyOf 1)	string	Alternative	Document ID number. Maximum length: 5000
number (anyOf 2)	null	Alternative
sex	JSON	Optional
sex (anyOf 1)	string	Alternative	Sex of the person in the document. Known values: [redacted], female, male, unknown
sex (anyOf 2)	null	Alternative
status	string	Required within parent	Status of this `document` check. Known values: unverified, verified
type	JSON	Optional
type (anyOf 1)	string	Alternative	Type of the document. Known values: driving_license, id_card, passport
type (anyOf 2)	null	Alternative
unparsed_place_of_birth	JSON	Optional
unparsed_place_of_birth (anyOf 1)	string	Alternative	Place of birth as it appears in the document. Maximum length: 5000
unparsed_place_of_birth (anyOf 2)	null	Alternative
unparsed_sex	JSON	Optional
unparsed_sex (anyOf 1)	string	Alternative	Sex as it appears in the document. Maximum length: 5000
unparsed_sex (anyOf 2)	null	Alternative

Referenced models: Create a Location — response body — address, Retrieve a Verification Report — response body — id number dob Date of birth Point in Time, Retrieve a Verification Report — response body — document error value code, reason

Retrieve a Verification Report — response body — email

Field	Type	Presence	Description and constraints
$	object	Root	Result from a email check
email	JSON	Optional
email (anyOf 1)	string	Alternative	Email to be verified. Maximum length: 5000
email (anyOf 2)	null	Alternative
error	JSON	Optional
error (anyOf 1)	JSON	Alternative	Details on the verification error. Present when status is `unverified`.
error (anyOf 1) (anyOf 1)	Model	Alternative	Expand Retrieve a Verification Report — response body — email error value code, reason
error (anyOf 2)	null	Alternative
status	string	Required within parent	Status of this `email` check. Known values: unverified, verified

Referenced models: Retrieve a Verification Report — response body — email error value code, reason

Create a Payment Method — response body — zip

Field	Type	Presence	Description and constraints
$	object	Root

Policy, approvals and errors

SDK function policy ID: stripe.getidentityverificationreports. Catalog operation: GetIdentityVerificationReports. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source