Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OpenAPI Update #679

Merged
merged 1 commit into from
Feb 22, 2024
Merged

OpenAPI Update #679

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions embedded/openapi/spec3.beta.sdk.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -18926,6 +18932,7 @@
}
},
"required": [
"client_reference_id",
"created",
"id",
"livemode",
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -19085,6 +19098,7 @@
}
},
"required": [
"client_reference_id",
"client_secret",
"created",
"id",
Expand Down Expand Up @@ -98827,6 +98841,17 @@
"description": "<p>List all verification reports.</p>",
"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,
Expand Down Expand Up @@ -99084,6 +99109,17 @@
"description": "<p>Returns a list of VerificationSessions</p>",
"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,
Expand Down Expand Up @@ -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": {
Expand Down
39 changes: 39 additions & 0 deletions embedded/openapi/spec3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -76996,6 +77008,17 @@
"description": "<p>List all verification reports.</p>",
"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,
Expand Down Expand Up @@ -77249,6 +77272,17 @@
"description": "<p>Returns a list of VerificationSessions</p>",
"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,
Expand Down Expand Up @@ -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": {
Expand Down
Loading