Source: schemas/sign-request-create-signer.generated.ts

  1. import * as schemas from '.';
  2. /**
  3.  * Signer fields used to create a Box Sign request object.
  4.  *
  5.  * The schema for a Signer object used in
  6.  * for creating a Box Sign request object.
  7.  */
  8. export interface SignRequestCreateSigner {
  9. 	/**
  10. 	 * Email address of the signer.
  11. 	 * The email address of the signer is required when making signature requests, except when using templates that are configured to include emails.
  12. 	 * Example: example@gmail.com
  13. 	 */
  14. 	email?: string;
  15. 	/**
  16. 	 * Defines the role of the signer in the signature request. A `signer`
  17. 	 * must sign the document and an `approver` must approve the document. A
  18. 	 * `final_copy_reader` only receives the final signed document and signing
  19. 	 * log.
  20. 	 * Example: signer
  21. 	 * @default signer
  22. 	 */
  23. 	role?: 'signer' | 'approver' | 'final_copy_reader';
  24. 	/**
  25. 	 * Used in combination with an embed URL for a sender. After the
  26. 	 * sender signs, they are redirected to the next `in_person` signer.
  27. 	 * Example: true
  28. 	 */
  29. 	is_in_person?: boolean;
  30. 	/**
  31. 	 * Order of the signer
  32. 	 * Example: 2
  33. 	 */
  34. 	order?: number;
  35. 	/**
  36. 	 * User ID for the signer in an external application responsible
  37. 	 * for authentication when accessing the embed URL.
  38. 	 * Example: 1234
  39. 	 */
  40. 	embed_url_external_user_id?: string;
  41. 	/**
  42. 	 * The URL that a signer will be redirected
  43. 	 * to after signing a document. Defining this URL
  44. 	 * overrides default or global redirect URL
  45. 	 * settings for a specific signer.
  46. 	 * If no declined redirect URL is specified,
  47. 	 * this URL will be used for decline actions as well.
  48. 	 * Example: https://example.com
  49. 	 */
  50. 	redirect_url?: string;
  51. 	/**
  52. 	 * The URL that a signer will be redirect
  53. 	 * to after declining to sign a document.
  54. 	 * Defining this URL overrides default or global
  55. 	 * declined redirect URL settings for a specific signer.
  56. 	 * Example: https://declined-example.com
  57. 	 */
  58. 	declined_redirect_url?: string;
  59. 	/**
  60. 	 * If set to true, the signer will need to log in to a Box account
  61. 	 * before signing the request. If the signer does not have
  62. 	 * an existing account, they will have the option to create
  63. 	 * a free Box account. Cannot be selected in combination with
  64. 	 * `verification_phone_number`.
  65. 	 * Example: true
  66. 	 */
  67. 	login_required?: boolean;
  68. 	/**
  69. 	 * If set, this phone number will be used to verify the signer
  70. 	 * via two-factor authentication before they are able to sign the document.
  71. 	 * Cannot be selected in combination with `login_required`.
  72. 	 * Example: 6314578901
  73. 	 */
  74. 	verification_phone_number?: string;
  75. 	/**
  76. 	 * If set, the signer is required to enter the password before they are able
  77. 	 * to sign a document. This field is write only.
  78. 	 * Example: SecretPassword123
  79. 	 */
  80. 	password?: string;
  81. 	/**
  82. 	 * If set, signers who have the same value will be assigned to the same input and to the same signer group.
  83. 	 * A signer group is not a Box Group. It is an entity that belongs to a Sign Request and can only be
  84. 	 * used/accessed within this Sign Request. A signer group is expected to have more than one signer.
  85. 	 * If the provided value is only used for one signer, this value will be ignored and request will be handled
  86. 	 * as it was intended for an individual signer. The value provided can be any string and only used to
  87. 	 * determine which signers belongs to same group. A successful response will provide a generated UUID value
  88. 	 * instead for signers in the same signer group.
  89. 	 * Example: cd4ff89-8fc1-42cf-8b29-1890dedd26d7
  90. 	 */
  91. 	signer_group_id?: string;
  92. 	/**
  93. 	 * If true, no emails about the sign request will be sent
  94. 	 */
  95. 	suppress_notifications?: boolean;
  96. }