| Field type | Type specific attributes | Example |
| text |
- `prefilled_text`: editable text that appears in the field when the signer opens the document.
- `lock_to_sign_prefill`: locks the pre-filled text to prevent the signer from editing it. Set to `true` to make the field read-only. Set to `false` to allow the signer to modify the pre-filled value. Default is `false`. Applies to `text` fields and requires a non-empty `prefilled_text` parameter.
- `label`: a hint for a recipient added to the field. When a recipient has filled out a labeled `text` field, all other `text` fields with the same `label` will be automatically filled out with the same data when the recipient clicks on that `text` field.
- `validator_id`: a string that adds format validation, such as date or email address. For a complete list of validators, use a `GET /validator` request or see [Data validators](/docs/fields#data-validators).
- `stretch_mode`: defines how the field is stretched if it's overflowed
- `fixed` (no changes)
- `horizontal`
- `vertical`
- `auto`
- `max_lines`: maximum number of lines
- `max_chars`: maximum number of characters
- `arrangement`
- `cells`: fit characters in individual cells. If used, the number of cells is set by `max_chars`
- `none`
- `bold`
- `italic`
- `underline`
- `font`
- Arial
- Times New Roman
- Courier New
- Tahoma
- Comic Sans MS
- `font_size`
- `color`: 6-number HEX color code
- `align`: horizontal alignment
- `left`
- `center`
- `right`
- `valign`: vertical alignment
- `top`
- `middle`
- `bottom`
|
```json
{
"type": "text",
"required": true,
"role": "Signer 1",
"page_number": 0,
"x": 217,
"y": 32,
"width": 50,
"height": 20,
"prefilled_text": "First name",
"stretch_mode": "horizontal",
"align": "center"
}
```
|
| signature |
`allowed_types`: an array of strings that define how the document can be signed. Possible values:
- `type` (user types the signature)
- `draw` (user draws the signature)
- `upload` (user uploads an image with the signature)
By default, all types are allowed.
|
```json
{
"type": "signature",
"required": true,
"role": "Signer 1",
"page_number": 0,
"x": 217,
"y": 32,
"width": 50,
"height": 20,
"allowed_types": [
"draw"
]
}
```
|
| initials |
`allowed_types`: an array of strings that define how the initials can be added. Possible values:
- `type` (user types the signature)
- `draw` (user draws the signature)
By default, all types are allowed.
|
```json
{
"type": "signature",
"required": true,
"role": "Signer 1",
"page_number": 0,
"x": 217,
"y": 32,
"width": 50,
"height": 20,
"allowed_types": [
"draw"
]
}
```
|
| checkbox |
- `prefilled_text`: if true, the checkbox is checked. By default, it's false.
- `value`: Value set to the checkbox field.
|
```json
{
"type": "checkbox",
"required": true,
"role": "Signer 1",
"name": "checkbox_field",
"value": "Option 1",
"page_number": 0,
"x": 217,
"y": 32,
"width": 15,
"height": 15,
"prefilled_text": 1
}
```
|
| attachment |
`label`: a hint in the field. When a dropdown value is selected, the label appears when a signer hovers over the field.
|
```json
{
"type": "attachment",
"name": "photo",
"label": "Your photo",
"required": true,
"role": "Signer 1",
"page_number": 0,
"x": 217,
"y": 32,
"width": 15,
"height": 15
}
```
|
| hyperlink |
**Required**
- `link`: a link that a signer can open.
**Optional**
- `hint`: a hint that appears when a signer hovers over the field.
- `label`: a name of the link in the field. It also appears when a signer hovers over the field.
Note: by default, hyperlink fields are off. To start using them, contact [SignNow support](https://support.signnow.com/).
|
```json
{
"type": "hyperlink",
"link": "https://uniquesolutions.com",
"name": "website",
"label": "Company website",
"hint": "For more information, follow the link",
"required": true,
"role": "Signer 1",
"page_number": 0,
"x": 217,
"y": 32,
"width": 40,
"height": 10
}
```
|
| radio button |
**Required**
- `radio`: an array of radio buttons. Each button must have the following attributes:
- `x`
- `y`
- `width`
- `height`
- `page_number`
- `value`
**Optional**
- `prefilled_text`: a value that should be checked. By default, no value is checked.
|
```json
{
"page_number": 0,
"type": "radiobutton",
"name": "US residency",
"role": "Signer 1",
"required": true,
"x": 389,
"y": 141,
"width": 23,
"height": 23,
"radio": [
{
"x": 389,
"y": 141,
"width": 23,
"height": 23,
"page_number": 0,
"value": "Yes"
},
{
"x": 389,
"y": 170,
"width": 23,
"height": 23,
"page_number": 0,
"value": "No"
}
],
"prefilled_text": "Yes"
}
```
|
| enumeration (dropdown) |
**Required**
- `enumeration_options`: an array of strings with the dropdown options.
**Optional**
- `custom_defined_options`: if true, a signer can type a new option. By default, it's false.
- `label`: a hint in the field. When a dropdown value is selected, the label appears when a signer hovers over the field.
|
```json
{
"fields": [
{
"page_number": 0,
"type": "enumeration",
"name": "Department",
"label": "Your department",
"role": "Signer 1",
"required": true,
"custom_defined_option": true,
"enumeration_options": [
"HR",
"IT",
"Finance"
],
"height": 40,
"width": 70,
"x": 100,
"y": 32
}
]
}
```
|
| stamp |
No additional attributes
|
```json
{
"type": "stamp",
"required": true,
"role": "Signer 1",
"page_number": 0,
"x": 217,
"y": 32,
"width": 100,
"height": 100,
"name": "Company stamp"
}
```
|
## Data validators
Use data validators to set a field format by adding a validator ID to your tag. For a list of validator IDs, use `GET /validator` or see the table below.
For [payment requests](/docs/reference) with field values, use the following validator IDs:
- US dollars: `150662c7221a6a6ebcbb7c50ca46359d19757f81`
- 12,345.60 format: `7ef095fd94ce63b670b52b2e83457d59ac796a39`
- 12.345,60 format: `824085fd04ce63b670b11b2e83457d59ac796a39`
| Format | Example | Validator ID |
| ---------------------------------------------- | ----------------------------------------------------------------------- | ---------------------------------------- |
| **DD/MM/YYYY** | 27/11/2008 | 059b068ef8ee5cc27e09ba79af58f9e805b7c2b3 |
| **MM/DD/YYYY** | 09/28/2008 | 13435fa6c2a17f83177fcbb5c4a9376ce85befeb |
| **DD-MON-YYYY** | 9-MAY-1981 | 07c1e60f3da1192b60aca6f7e72d9b17a44539e5 |
| **DD/MM/YY** | 31/12/75 | 0b61eb6a696da953910f195b30c86e5131f3ae3e |
| **Mmm dd, yyyy** | Jan 1, 2003