diff --git a/openapi.json b/openapi.json index c0e816c1..ab7e0250 100644 --- a/openapi.json +++ b/openapi.json @@ -14,7 +14,7 @@ "url": "https://www.apache.org/licenses/LICENSE-2.0" }, "version": "2024.0", - "x-box-commit-hash": "e34422e289" + "x-box-commit-hash": "d1f2984418" }, "servers": [ { @@ -39323,6 +39323,24 @@ "type": "string", "example": "en", "nullable": true + }, + "verification_method": { + "description": "The verification method for the signer.", + "example": { + "type": "login" + }, + "anyOf": [ + { + "$ref": "#/components/schemas/SignRequestSignerVerificationMethod" + }, + { + "title": "OpenAPI 3.0 null schema type", + "description": "The definition for a null schema type in OpenAPI `3.0`.", + "type": "object", + "nullable": true, + "additionalProperties": false + } + ] } }, "title": "Signer fields used to create a Box Sign request object." @@ -39841,6 +39859,81 @@ ], "title": "Sign Request Signer Input ZIP Validation" }, + "SignRequestSignerVerificationMethod": { + "description": "A verification method for a signer in a Sign Request. \nThis property can be used instead of the `login_required` and `verification_phone_number` properties.\nIf this property is used, the `login_required` and `verification_phone_number` properties will be ignored.", + "oneOf": [ + { + "$ref": "#/components/schemas/SignRequestSignerVerificationMethodLogin" + }, + { + "$ref": "#/components/schemas/SignRequestSignerVerificationMethodPhoneSMS" + }, + { + "$ref": "#/components/schemas/SignRequestSignerVerificationMethodCacPiv" + } + ], + "title": "Verification method for Sign Request Signer" + }, + "SignRequestSignerVerificationMethodCacPiv": { + "description": "The verification method to be used when user has to verify themselves using a CAC/PIV smart-card.", + "type": "object", + "properties": { + "type": { + "description": "The type of verification method.", + "type": "string", + "example": "cac_piv", + "enum": [ + "cac_piv" + ] + } + }, + "required": [ + "type" + ], + "title": "CAC/PIV Signer Verification Method" + }, + "SignRequestSignerVerificationMethodLogin": { + "description": "When used as a verification method the signer will need to \nlog in to a Box account before signing the request. If the \nsigner does not have an existing account, they will have the \noption to create a free Box account.", + "type": "object", + "properties": { + "type": { + "description": "The type of verification method.", + "type": "string", + "example": "login", + "enum": [ + "login" + ] + } + }, + "required": [ + "type" + ], + "title": "Login Signer Verification Method" + }, + "SignRequestSignerVerificationMethodPhoneSMS": { + "description": "When used as a verification method, prior to signing the document, \nthe signer will have to verify themselves using two-factor \nauthentication by receiving an SMS message on their phone.", + "type": "object", + "properties": { + "type": { + "description": "The type of verification method.", + "type": "string", + "example": "phone", + "enum": [ + "phone" + ] + }, + "phone_number": { + "description": "The phone number to where the message will be sent.", + "type": "string", + "example": "+316314578901" + } + }, + "required": [ + "type", + "phone_number" + ], + "title": "Phone SMS Signer Verification Method" + }, "SignTemplate": { "description": "A Box Sign template object.", "type": "object", @@ -40820,6 +40913,24 @@ "type": "boolean", "example": true, "nullable": true + }, + "verification_method": { + "description": "The verification method for the signer.", + "example": { + "type": "login" + }, + "anyOf": [ + { + "$ref": "#/components/schemas/TemplateSignerVerificationMethod" + }, + { + "title": "OpenAPI 3.0 null schema type", + "description": "The definition for a null schema type in OpenAPI `3.0`.", + "type": "object", + "nullable": true, + "additionalProperties": false + } + ] } }, "title": "Signer fields for Templates" @@ -40973,6 +41084,75 @@ ], "title": "Template Signer Input" }, + "TemplateSignerVerificationMethod": { + "description": "A verification method for a signer in a Sign Request Template.\nThis property can be used instead of the `login_required`, `is_phone_number_required` properties.\nIf this property is used, the `login_required` and `is_phone_number_required` properties will be ignored.", + "oneOf": [ + { + "$ref": "#/components/schemas/TemplateSignerVerificationMethodLogin" + }, + { + "$ref": "#/components/schemas/TemplateSignerVerificationMethodPhoneSMS" + }, + { + "$ref": "#/components/schemas/TemplateSignerVerificationMethodCacPiv" + } + ], + "title": "Verification method for Sign Request Template Signer" + }, + "TemplateSignerVerificationMethodCacPiv": { + "description": "The verification method to be used when user has to verify themselves using a CAC/PIV smart-card.", + "type": "object", + "properties": { + "type": { + "description": "The type of verification method.", + "type": "string", + "example": "cac_piv", + "enum": [ + "cac_piv" + ] + } + }, + "required": [ + "type" + ], + "title": "Template Signer CAC/PIV Verification Method" + }, + "TemplateSignerVerificationMethodLogin": { + "description": "When used as a verification method the signer will need to \nlog in to a Box account before signing the request. If the \nsigner does not have an existing account, they will have the \noption to create a free Box account.", + "type": "object", + "properties": { + "type": { + "description": "The type of verification method.", + "type": "string", + "example": "login", + "enum": [ + "login" + ] + } + }, + "required": [ + "type" + ], + "title": "Template Signer Login Verification Method" + }, + "TemplateSignerVerificationMethodPhoneSMS": { + "description": "When used as a verification method, prior to signing the document, \nthe signer will have to verify themselves using two-factor \nauthentication by receiving an SMS message on their phone.", + "type": "object", + "properties": { + "type": { + "description": "The type of verification method.", + "type": "string", + "example": "phone", + "enum": [ + "phone" + ] + } + }, + "required": [ + "type" + ], + "title": "Template Signer Phone SMS Verification Method" + }, "TermsOfService": { "description": "The root-level record that is supposed to represent a\nsingle Terms of Service.", "type": "object", diff --git a/openapi/openapi-v2025.0.json b/openapi/openapi-v2025.0.json index 453cfa1c..e171346c 100644 --- a/openapi/openapi-v2025.0.json +++ b/openapi/openapi-v2025.0.json @@ -14,7 +14,7 @@ "url": "https://www.apache.org/licenses/LICENSE-2.0" }, "version": "2025.0", - "x-box-commit-hash": "e34422e289" + "x-box-commit-hash": "d1f2984418" }, "servers": [ { diff --git a/openapi/openapi-v2026.0.json b/openapi/openapi-v2026.0.json index 1c1a7da8..fa6ac424 100644 --- a/openapi/openapi-v2026.0.json +++ b/openapi/openapi-v2026.0.json @@ -14,7 +14,7 @@ "url": "https://www.apache.org/licenses/LICENSE-2.0" }, "version": "2026.0", - "x-box-commit-hash": "e34422e289" + "x-box-commit-hash": "d1f2984418" }, "servers": [ { diff --git a/openapi/openapi.json b/openapi/openapi.json index c0e816c1..ab7e0250 100644 --- a/openapi/openapi.json +++ b/openapi/openapi.json @@ -14,7 +14,7 @@ "url": "https://www.apache.org/licenses/LICENSE-2.0" }, "version": "2024.0", - "x-box-commit-hash": "e34422e289" + "x-box-commit-hash": "d1f2984418" }, "servers": [ { @@ -39323,6 +39323,24 @@ "type": "string", "example": "en", "nullable": true + }, + "verification_method": { + "description": "The verification method for the signer.", + "example": { + "type": "login" + }, + "anyOf": [ + { + "$ref": "#/components/schemas/SignRequestSignerVerificationMethod" + }, + { + "title": "OpenAPI 3.0 null schema type", + "description": "The definition for a null schema type in OpenAPI `3.0`.", + "type": "object", + "nullable": true, + "additionalProperties": false + } + ] } }, "title": "Signer fields used to create a Box Sign request object." @@ -39841,6 +39859,81 @@ ], "title": "Sign Request Signer Input ZIP Validation" }, + "SignRequestSignerVerificationMethod": { + "description": "A verification method for a signer in a Sign Request. \nThis property can be used instead of the `login_required` and `verification_phone_number` properties.\nIf this property is used, the `login_required` and `verification_phone_number` properties will be ignored.", + "oneOf": [ + { + "$ref": "#/components/schemas/SignRequestSignerVerificationMethodLogin" + }, + { + "$ref": "#/components/schemas/SignRequestSignerVerificationMethodPhoneSMS" + }, + { + "$ref": "#/components/schemas/SignRequestSignerVerificationMethodCacPiv" + } + ], + "title": "Verification method for Sign Request Signer" + }, + "SignRequestSignerVerificationMethodCacPiv": { + "description": "The verification method to be used when user has to verify themselves using a CAC/PIV smart-card.", + "type": "object", + "properties": { + "type": { + "description": "The type of verification method.", + "type": "string", + "example": "cac_piv", + "enum": [ + "cac_piv" + ] + } + }, + "required": [ + "type" + ], + "title": "CAC/PIV Signer Verification Method" + }, + "SignRequestSignerVerificationMethodLogin": { + "description": "When used as a verification method the signer will need to \nlog in to a Box account before signing the request. If the \nsigner does not have an existing account, they will have the \noption to create a free Box account.", + "type": "object", + "properties": { + "type": { + "description": "The type of verification method.", + "type": "string", + "example": "login", + "enum": [ + "login" + ] + } + }, + "required": [ + "type" + ], + "title": "Login Signer Verification Method" + }, + "SignRequestSignerVerificationMethodPhoneSMS": { + "description": "When used as a verification method, prior to signing the document, \nthe signer will have to verify themselves using two-factor \nauthentication by receiving an SMS message on their phone.", + "type": "object", + "properties": { + "type": { + "description": "The type of verification method.", + "type": "string", + "example": "phone", + "enum": [ + "phone" + ] + }, + "phone_number": { + "description": "The phone number to where the message will be sent.", + "type": "string", + "example": "+316314578901" + } + }, + "required": [ + "type", + "phone_number" + ], + "title": "Phone SMS Signer Verification Method" + }, "SignTemplate": { "description": "A Box Sign template object.", "type": "object", @@ -40820,6 +40913,24 @@ "type": "boolean", "example": true, "nullable": true + }, + "verification_method": { + "description": "The verification method for the signer.", + "example": { + "type": "login" + }, + "anyOf": [ + { + "$ref": "#/components/schemas/TemplateSignerVerificationMethod" + }, + { + "title": "OpenAPI 3.0 null schema type", + "description": "The definition for a null schema type in OpenAPI `3.0`.", + "type": "object", + "nullable": true, + "additionalProperties": false + } + ] } }, "title": "Signer fields for Templates" @@ -40973,6 +41084,75 @@ ], "title": "Template Signer Input" }, + "TemplateSignerVerificationMethod": { + "description": "A verification method for a signer in a Sign Request Template.\nThis property can be used instead of the `login_required`, `is_phone_number_required` properties.\nIf this property is used, the `login_required` and `is_phone_number_required` properties will be ignored.", + "oneOf": [ + { + "$ref": "#/components/schemas/TemplateSignerVerificationMethodLogin" + }, + { + "$ref": "#/components/schemas/TemplateSignerVerificationMethodPhoneSMS" + }, + { + "$ref": "#/components/schemas/TemplateSignerVerificationMethodCacPiv" + } + ], + "title": "Verification method for Sign Request Template Signer" + }, + "TemplateSignerVerificationMethodCacPiv": { + "description": "The verification method to be used when user has to verify themselves using a CAC/PIV smart-card.", + "type": "object", + "properties": { + "type": { + "description": "The type of verification method.", + "type": "string", + "example": "cac_piv", + "enum": [ + "cac_piv" + ] + } + }, + "required": [ + "type" + ], + "title": "Template Signer CAC/PIV Verification Method" + }, + "TemplateSignerVerificationMethodLogin": { + "description": "When used as a verification method the signer will need to \nlog in to a Box account before signing the request. If the \nsigner does not have an existing account, they will have the \noption to create a free Box account.", + "type": "object", + "properties": { + "type": { + "description": "The type of verification method.", + "type": "string", + "example": "login", + "enum": [ + "login" + ] + } + }, + "required": [ + "type" + ], + "title": "Template Signer Login Verification Method" + }, + "TemplateSignerVerificationMethodPhoneSMS": { + "description": "When used as a verification method, prior to signing the document, \nthe signer will have to verify themselves using two-factor \nauthentication by receiving an SMS message on their phone.", + "type": "object", + "properties": { + "type": { + "description": "The type of verification method.", + "type": "string", + "example": "phone", + "enum": [ + "phone" + ] + } + }, + "required": [ + "type" + ], + "title": "Template Signer Phone SMS Verification Method" + }, "TermsOfService": { "description": "The root-level record that is supposed to represent a\nsingle Terms of Service.", "type": "object",