The VerificationReport object

Attributes

id string Unique identifier for the object.
object string, value is "identity.verification_report" String representing the object’s type. Objects of the same type share the same value.
client _ reference _ id nullable 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.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
document nullable object Result of the document check for this report.
email nullable object Result of the email check for this report.
id _ number nullable object Result of the id number check for this report.
livemode boolean If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
options nullable object Configuration options for this report.
phone nullable object Result of the phone check for this report.
selfie nullable object Result of the selfie check for this report.
type enum Type of report. Possible enum values document Perform a document check. id_number Perform an ID number check. verification_flow Configuration provided by verification flow
verification _ flow nullable string The configuration token of a verification flow from the dashboard.
verification _ session nullable 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" }}

Retrieve a VerificationReport

GET / v1 / identity / verification_reports /:id

Retrieves an existing VerificationReport

Parameters

No parameters.

Returns

Returns a VerificationReport object

Response

{ "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 VerificationReports

GET / v1 / identity / verification_reports

List all verification reports.

Parameters

client _ reference _ id 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.
created object Only return VerificationReports that were created during the given date interval.
type enum Only return VerificationReports of this type Possible enum values document Perform a document check. id_number Perform an ID number check.
verification _ session string Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID.

More parameters

ending _ before string
limit integer
starting _ after string

Returns

List of VerificationInent objects that match the provided filter criteria.

Response