Box · Schema
Signer fields for Templates
The schema for a Signer for Templates
Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/TemplateSigner",
"title": "Signer fields for Templates",
"type": "object",
"description": "The schema for a Signer for Templates",
"allOf": [
{
"properties": {
"inputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateSignerInput"
},
"readOnly": true
},
"email": {
"type": "string",
"description": "Email address of the signer",
"example": "[email protected]",
"nullable": true
},
"role": {
"type": "string",
"enum": [
"signer",
"approver",
"final_copy_reader"
],
"description": "Defines the role of the signer in the signature request. A role of\n`signer` needs to sign the document, a role `approver`\napproves the document and\na `final_copy_reader` role only\nreceives the final signed document and signing log.",
"example": "signer",
"default": "signer"
},
"is_in_person": {
"type": "boolean",
"description": "Used in combination with an embed URL for a sender.\nAfter the sender signs, they will be\nredirected to the next `in_person` signer.",
"example": true
},
"order": {
"type": "integer",
"description": "Order of the signer",
"minimum": 0,
"example": 2
},
"signer_group_id": {
"type": "string",
"description": "If provided, this value points signers that are assigned the same inputs and belongs to same signer group.\nA signer group is not a Box Group. It is an entity that belongs to the template itself and can only be used\nwithin Sign Requests created from it.",
"example": "cd4ff89-8fc1-42cf-8b29-1890dedd26d7",
"nullable": true
}
}
}
]
}