PostIdentityVerificationSessionsRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/stripe/main/json-schema/stripe-post-identity-verification-sessions-request-schema.json",
  "title": "PostIdentityVerificationSessionsRequest",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/stripe-identity-api-openapi.yml#/components/schemas/PostIdentityVerificationSessionsRequest",
  "type": "object",
  "required": [
    "type"
  ],
  "properties": {
    "expand": {
      "description": "Specifies which fields in the response should be expanded.",
      "items": {
        "maxLength": 5000,
        "type": "string"
      },
      "type": "array"
    },
    "metadata": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.",
      "type": "object"
    },
    "options": {
      "description": "A set of options for the session’s verification checks.",
      "properties": {
        "document": {
          "anyOf": [
            {
              "properties": {
                "allowed_types": {
                  "items": {
                    "enum": [
                      "driving_license",
                      "id_card",
                      "passport"
                    ],
                    "type": "string"
                  },
                  "type": "array"
                },
                "require_id_number": {
                  "type": "boolean"
                },
                "require_live_capture": {
                  "type": "boolean"
                },
                "require_matching_selfie": {
                  "type": "boolean"
                }
              },
              "title": "document_options",
              "type": "object"
            },
            {
              "enum": [
                ""
              ],
              "type": "string"
            }
          ]
        }
      },
      "title": "session_options_param",
      "type": "object"
    },
    "return_url": {
      "description": "The URL that the user will be redirected to upon completing the verification flow.",
      "type": "string"
    },
    "type": {
      "description": "The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.",
      "enum": [
        "document",
        "id_number"
      ],
      "type": "string",
      "x-stripeBypassValidation": true
    }
  }
}