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_
, 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.
Attributes
- idstring
Unique identifier for the object.
- objectstring
String representing the object’s type. Objects of the same type share the same value.
- client_
reference_ idnullable string 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.
- createdtimestamp
Time at which the object was created. Measured in seconds since the Unix epoch.
- documentnullable object
Result of the document check for this report.
- emailnullable object
Result of the email check for this report.
- id_
numbernullable object Result of the id number check for this report.
- livemodeboolean
Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - optionsnullable object
Configuration options for this report.
- phonenullable object
Result of the phone check for this report.
- selfienullable object
Result of the selfie check for this report.
- typeenum
Type of report.
Possible enum valuesdocument
Perform a document check.
id_
number Perform an ID number check.
verification_
flow Configuration provided by verification flow
- verification_
flownullable string The configuration token of a verification flow from the dashboard.
- verification_
sessionnullable string ID of the VerificationSession that created this report.
{ "id": "vr_1MwBlH2eZvKYlo2C91hOpFMf", "object": "identity.verification_report", "created": 1681337011, "livemode": false, "options": { "document": {} }, "type": "document", "verification_session": "vs_NhaxYCqOE27AqaUTxbIZOnHw", "document": { "status": "verified", "error": null, "first_name": "Jenny", "last_name": "Rosen", "address": { "line1": "1234 Main St.", "city": "San Francisco", "state": "CA", "zip": "94111", "country": "US" }, "type": "driving_license", "files": [ "file_NhaxRCXT8Iuu8apSuci00UC4", "file_NhaxDeWKGAOTc8Uec7UY9Ljj" ], "expiration_date": { "month": 12, "day": 1, "year": 2025 }, "issued_date": { "month": 12, "day": 1, "year": 2020 }, "issuing_country": "US" }}
Retrieves an existing VerificationReport
Parameters
No parameters.
Returns
Returns a VerificationReport object
{ "id": "vr_1MwBlH2eZvKYlo2C91hOpFMf", "object": "identity.verification_report", "created": 1681337011, "livemode": false, "options": { "document": {} }, "type": "document", "verification_session": "vs_NhaxYCqOE27AqaUTxbIZOnHw", "document": { "status": "verified", "error": null, "first_name": "Jenny", "last_name": "Rosen", "address": { "line1": "1234 Main St.", "city": "San Francisco", "state": "CA", "zip": "94111", "country": "US" }, "type": "driving_license", "files": [ "file_NhaxRCXT8Iuu8apSuci00UC4", "file_NhaxDeWKGAOTc8Uec7UY9Ljj" ], "expiration_date": { "month": 12, "day": 1, "year": 2025 }, "issued_date": { "month": 12, "day": 1, "year": 2020 }, "issuing_country": "US" }}
List all verification reports.
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 VerificationReports that were created during the given date interval.
- typeenum
Only return VerificationReports of this type
Possible enum valuesdocument
Perform a document check.
id_
number Perform an ID number check.
- verification_
sessionstring Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
List of VerificationInent objects that match the provided filter criteria.
{ "object": "list", "url": "/v1/identity/verification_reports", "has_more": false, "data": [ { "id": "vr_1MwBlH2eZvKYlo2C91hOpFMf", "object": "identity.verification_report", "created": 1681337011, "livemode": false, "options": { "document": {} }, "type": "document", "verification_session": "vs_NhaxYCqOE27AqaUTxbIZOnHw", "document": { "status": "verified", "error": null, "first_name": "Jenny", "last_name": "Rosen", "address": { "line1": "1234 Main St.", "city": "San Francisco", "state": "CA", "zip": "94111", "country": "US" }, "type": "driving_license", "files": [ "file_NhaxRCXT8Iuu8apSuci00UC4", "file_NhaxDeWKGAOTc8Uec7UY9Ljj" ], "expiration_date": { "month": 12, "day": 1, "year": 2025 }, "issued_date": { "month": 12, "day": 1, "year": 2020 }, "issuing_country": "US" } } ]}
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