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
If the object exists in live mode, the value is
true. If the object exists in test mode, the value isfalse. - 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 valuesdocumentPerform 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": [ ], "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
curl https://api.stripe.com/v1/identity/verification_reports/{{VERIFICATION_REPORT_ID}} \ -u "sk_test_Hrs6SAopgFPF0bZXSN3f6ELNsk_test_Hrs6SAopgFPF0bZXSN3f6ELN:"{ "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": [ ], "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 valuesdocumentPerform 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": [ ], "expiration_date": { "month": 12, "day": 1, "year": 2025 }, "issued_date": { "month": 12, "day": 1, "year": 2020 }, "issuing_country": "US" } } ]}