Create a VerificationSession

Creates a VerificationSession object.

After the VerificationSession is created, display a verification modal using the session client_secret or send your users to the session’s url.

If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.

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.

metadataobject
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.

optionsobject
A set of options for the session’s verification checks.

provided_detailsobject
Details provided about the user being verified. These details may be shown to the user.

related_customerstring
Token referencing a Customer resource.

return_urlstring
The URL that the user will be redirected to upon completing the verification flow.

typeenum
The type of verification check to be performed. You must provide a type if not passing verification_flow.
Possible enum values
document
Document check.
id_number
ID number check.

verification_flowstring
The ID of a verification flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows.

Returns

Returns the created VerificationSession object

POST /v1/identity/verification_sessions

Server-side language

curl https://api.stripe.com/v1/identity/verification_sessions \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d type=document

Response

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

Update a VerificationSession

Updates a VerificationSession object.

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

Parameters

metadataobject
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.

optionsobject
A set of options for the session’s verification checks.

provided_detailsobject
Details provided about the user being verified. These details may be shown to the user.

typeenum
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

POST /v1/identity/verification_sessions/:id

Server-side language

curl https://api.stripe.com/v1/identity/verification_sessions/vs_1NuN9WLkdIwHu7ix597AR9uz \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d type=id_number

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

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

GET /v1/identity/verification_sessions/:id

Server-side language

curl https://api.stripe.com/v1/identity/verification_sessions/vs_1NuNAILkdIwHu7ixh7OtGMLw \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"

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

Returns a list of VerificationSessions

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 VerificationSessions that were created during the given date interval.

statusenum

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_beforestring

limitinteger

starting_afterstring

Returns

List of VerificationSession objects that match the provided filter criteria.

GET /v1/identity/verification_sessions

Server-side language

curl -G https://api.stripe.com/v1/identity/verification_sessions \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d limit=3

Response

{
  "object": "list",
  "url": "/v1/identity/verification_sessions",
  "has_more": false,
  "data": [
    {
      "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": "..."
    }
  ]
}

Cancel a VerificationSession

A VerificationSession object can be canceled when it is in requires_input status.

Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.

Parameters

No parameters.

Returns

Returns the canceled VerificationSession object

POST /v1/identity/verification_sessions/:id/cancel

Server-side language

curl -X POST https://api.stripe.com/v1/identity/verification_sessions/vs_1NuN3kLkdIwHu7ixk5OvTq3b/cancel \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"

Response

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

Create a VerificationSession

Parameters

client_reference_idstring

metadataobject

optionsobject

provided_detailsobject

related_customerstring

return_urlstring

typeenum

verification_flowstring

Returns

Update a VerificationSession

Parameters

metadataobject

optionsobject

provided_detailsobject

typeenum

Returns

Retrieve a VerificationSession

Parameters

Returns

List VerificationSessions

Parameters

client_reference_idstring

createdobject

statusenum

More parametersExpand all

ending_beforestring

limitinteger

starting_afterstring

Returns

Cancel a VerificationSession

Parameters

Returns

More parameters