Skip to content

feat: Add verification method field to BoxSign Signer schema #626

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

Merged
lukaszsocha2 merged 1 commit into from
Nov 9, 2026
Merged

feat: Add verification method field to BoxSign Signer schema #626

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
182 changes: 181 additions & 1 deletion openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
{
Expand Down Expand Up @@ -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."
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion openapi/openapi-v2025.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
{
Expand Down
2 changes: 1 addition & 1 deletion openapi/openapi-v2026.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
{
Expand Down
Loading
Loading