Request object for creating a new signer in a transaction. Defines the signer's identity, authentication/verification requirements, notification preferences, and signing behavior.
Key Requirements:
| Name | Type | Description |
|---|---|---|
| Id | String | Signer identifier (can be provided or generated) |
| Expires | String | When the signer's access expires |
| String | Required. Signer's email address | |
| Authentications | Array<SignerAuthentication> | List of authentications that the signer has to authenticate with. The order in which the authentications are provided determine in which order the signer will have to perform the specified method. Authentications must be performed before the document(s) can be viewed. When the authentication SecureDownload is configured, the download url for a signer is authenticated with the same method as the signing url. The download url is returned in the response, and (optionally) emailed to the signer. You must explicitly specify the API-version when using this feature. This is done with the header: 'Accept: application/vnd.signhost.v1+json'. |
| Verifications | Array<SignerVerification> | List of verifications that the signer has to verify with. The order in which the verifications are provided determine in which order the signer will have to perform the specified method. Verifications must be performed before the document(s) can be signed. Critical Requirement: You must use one of the following verification methods as the last verification in the list:
Important Notes:
Common mistake: Providing only authentication methods (e.g., iDIN) without including one of these required final verification methods. |
| SendSignRequest | Boolean | Whether to send sign request to this signer's email address |
| SendSignConfirmation | Boolean | Whether to send a confirmation email to the signer after signing. Default value is the value of |
| SignRequestSubject | String | The subject of the sign request email in plain text. Maximum of 64 characters allowed. If omitted, the default subject will be used. |
| SignRequestMessage | String | The message of the sign request email in plain text. HTML is not allowed. Newlines can be created by including a |
| DaysToRemind | Integer | Number of days between automatic reminder emails sent to this signer.
Note: Reminders are only sent if |
| Language | enum:
| Language for signer interface and emails |
| Reference | String | Custom reference for this signer |
| IntroText | String | Custom introduction text shown to the signer during the signing proces. This will be shown on the first screen to the signer and supports limited markdown markup. The following markup is supported:
|
| ReturnUrl | String | URL to redirect signer after signing |
| AllowDelegation | Boolean | Whether this signer can delegate signing to another person. Cannot be used together with |
| Context | Object | Custom signer data (dynamic JSON object) |