Update a VerificationSession

POST / v1 / identity / verification_sessions /:id

Updates a VerificationSession object.

When the session status is requires_input, you can use this method to update the verification check and options.

Parameters

• metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
• options object A set of options for the session’s verification checks.
• provided _ details object Details provided about the user being verified. These details may be shown to the user.
• type enum The type of verification check to be performed. Possible enum values document Document check. id_number ID number check.

Returns

Returns the updated VerificationSession object

Response

{ "id": "vs_1NuN9WLkdIwHu7ix597AR9uz", "object": "identity.verification_session", "client_secret": "...", "created": 1695680478, "last_error": null, "last_verification_report": null, "livemode": false, "metadata": {}, "options": {}, "redaction": null, "status": "requires_input", "type": "id_number", "url": "..."}

Retrieve a VerificationSession

GET / v1 / identity / verification_sessions /:id

Retrieves the details of a VerificationSession that was previously created.

When the session status is requires_input, you can use this method to retrieve a valid client_secret or url to allow re-submission.

Parameters

No parameters.

Returns

Returns a VerificationSession object

Response

{ "id": "vs_1NuNAILkdIwHu7ixh7OtGMLw", "object": "identity.verification_session", "client_secret": "...", "created": 1695680526, "last_error": null, "last_verification_report": null, "livemode": false, "metadata": {}, "options": { "document": { "require_matching_selfie": true } }, "redaction": null, "status": "requires_input", "type": "document", "url": "..."}

List VerificationSessions

GET / v1 / identity / verification_sessions

Returns a list of VerificationSessions

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 VerificationSessions that were created during the given date interval.
• related _ customer string Customer ID
• related _ customer _ account string The ID of the Account representing a customer.
• status enum Only return VerificationSessions with this status. Learn more about the lifecycle of sessions. Possible enum values canceled The VerificationSession has been invalidated for future submission attempts. processing The session has been submitted and is being processed. Most verification checks are processed in less than 1 minute. requires_input Requires user input before processing can continue. verified Processing of all the verification checks are complete and successfully verified.

More parameters

• ending _ before string
• limit integer
• starting _ after string

Returns

List of VerificationSession objects that match the provided filter criteria.

Response