Stripe/getIdentityVerificationReports

Loading the complete reference automatically…

StripeStripe Identity verification API

GET/v1/identity/verification_reports

List VerificationReports

List all verification reports.

Create, retrieve, update, cancel, and redact Stripe Identity verification sessions, and retrieve verification reports. The collection covers all 8 Endpoints under the official Identity path boundary, including one-off debugging requests from the web Playground with the current session's credentials.

Request

operationId
getIdentityVerificationReports
Server
https://api.stripe.com
Authentication
bearerAuth

Request parameters

client_reference_id

querystring

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.

created

querystring

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

ending_before

querystring

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.

expand

queryarray

Specifies which fields in the response should be expanded.

limit

queryinteger

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

starting_after

querystring

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.

type

querystring

Only return VerificationReports of this type

verification_session

querystring

Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID.

Responses

200

objectapplication/json

Successful response.

Properties: datahas_moreobjecturl

default

stripe_errorapplication/json

Error response.

Properties: error

{
  "data": {
    "created": 0,
    "document": {
      "files": []
    },
    "email": {
      "status": "unverified"
    },
    "id_number": {
      "id_number_type": "br_cpf",
      "status": "unverified"
    },
    "livemode": false,
    "object": "identity.verification_report"
  },
  "has_more": false,
  "object": "list"
}