From a88fe3ef68f5b33c359c30b26e35ca45441b72c5 Mon Sep 17 00:00:00 2001 From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Thu, 22 Feb 2024 17:27:51 +0000 Subject: [PATCH] Update OpenAPI for 295cd3c80ac85799fbaa4ea885ca58830a690dd3 --- embedded/openapi/spec3.beta.sdk.json | 41 ++++++++++++++++++++++++++++ embedded/openapi/spec3.json | 39 ++++++++++++++++++++++++++ 2 files changed, 80 insertions(+) diff --git a/embedded/openapi/spec3.beta.sdk.json b/embedded/openapi/spec3.beta.sdk.json index 79a068c6..fd4e3cca 100644 --- a/embedded/openapi/spec3.beta.sdk.json +++ b/embedded/openapi/spec3.beta.sdk.json @@ -18876,6 +18876,12 @@ "identity.verification_report": { "description": "A VerificationReport is the result of an attempt to collect and verify data from a user.\nThe collection of verification checks performed is determined from the `type` and `options`\nparameters used. You can find the result of each verification check performed in the\nappropriate sub-resource: `document`, `id_number`, `selfie`.\n\nEach VerificationReport contains a copy of any data collected by the user as well as\nreference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/docs/api/files)\nAPI. To configure and create VerificationReports, use the\n[VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API.\n\nRelated guides: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results).", "properties": { + "client_reference_id": { + "description": "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.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", @@ -18926,6 +18932,7 @@ } }, "required": [ + "client_reference_id", "created", "id", "livemode", @@ -18966,6 +18973,12 @@ "identity.verification_session": { "description": "A VerificationSession guides you through the process of collecting and verifying the identities\nof your users. It contains details about the type of verification, such as what [verification\ncheck](/docs/identity/verification-checks) to perform. Only create one VerificationSession for\neach verification in your system.\n\nA VerificationSession transitions through [multiple\nstatuses](/docs/identity/how-sessions-work) throughout its lifetime as it progresses through\nthe verification flow. The VerificationSession contains the user's verified data after\nverification checks are complete.\n\nRelated guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions)", "properties": { + "client_reference_id": { + "description": "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.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "client_secret": { "description": "The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more.", "maxLength": 5000, @@ -19085,6 +19098,7 @@ } }, "required": [ + "client_reference_id", "client_secret", "created", "id", @@ -98827,6 +98841,17 @@ "description": "

List all verification reports.

", "operationId": "GetIdentityVerificationReports", "parameters": [ + { + "description": "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.", + "in": "query", + "name": "client_reference_id", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, { "description": "Only return VerificationReports that were created during the given date interval.", "explode": true, @@ -99084,6 +99109,17 @@ "description": "

Returns a list of VerificationSessions

", "operationId": "GetIdentityVerificationSessions", "parameters": [ + { + "description": "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.", + "in": "query", + "name": "client_reference_id", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, { "description": "Only return VerificationSessions that were created during the given date interval.", "explode": true, @@ -99280,6 +99316,11 @@ "schema": { "additionalProperties": false, "properties": { + "client_reference_id": { + "description": "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.", + "maxLength": 5000, + "type": "string" + }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { diff --git a/embedded/openapi/spec3.json b/embedded/openapi/spec3.json index 7314d937..03023296 100644 --- a/embedded/openapi/spec3.json +++ b/embedded/openapi/spec3.json @@ -12162,6 +12162,12 @@ "identity.verification_report": { "description": "A VerificationReport is the result of an attempt to collect and verify data from a user.\nThe collection of verification checks performed is determined from the `type` and `options`\nparameters used. You can find the result of each verification check performed in the\nappropriate sub-resource: `document`, `id_number`, `selfie`.\n\nEach VerificationReport contains a copy of any data collected by the user as well as\nreference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/docs/api/files)\nAPI. To configure and create VerificationReports, use the\n[VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API.\n\nRelated guides: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results).", "properties": { + "client_reference_id": { + "description": "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.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", @@ -12230,6 +12236,12 @@ "identity.verification_session": { "description": "A VerificationSession guides you through the process of collecting and verifying the identities\nof your users. It contains details about the type of verification, such as what [verification\ncheck](/docs/identity/verification-checks) to perform. Only create one VerificationSession for\neach verification in your system.\n\nA VerificationSession transitions through [multiple\nstatuses](/docs/identity/how-sessions-work) throughout its lifetime as it progresses through\nthe verification flow. The VerificationSession contains the user's verified data after\nverification checks are complete.\n\nRelated guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions)", "properties": { + "client_reference_id": { + "description": "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.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "client_secret": { "description": "The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more.", "maxLength": 5000, @@ -76996,6 +77008,17 @@ "description": "

List all verification reports.

", "operationId": "GetIdentityVerificationReports", "parameters": [ + { + "description": "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.", + "in": "query", + "name": "client_reference_id", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, { "description": "Only return VerificationReports that were created during the given date interval.", "explode": true, @@ -77249,6 +77272,17 @@ "description": "

Returns a list of VerificationSessions

", "operationId": "GetIdentityVerificationSessions", "parameters": [ + { + "description": "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.", + "in": "query", + "name": "client_reference_id", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, { "description": "Only return VerificationSessions that were created during the given date interval.", "explode": true, @@ -77441,6 +77475,11 @@ "schema": { "additionalProperties": false, "properties": { + "client_reference_id": { + "description": "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.", + "maxLength": 5000, + "type": "string" + }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": {