| GET | /FormFiller/GetSignerTemplate/{TemplateReference} | Gets all signer details in a single template | Gets a single template. Returns a collection of signers required for signing the template. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TemplateReference | path | string | Yes | Template reference |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | Template name |
| Reference | form | string | Yes | Identifier |
| Signers | form | array | Yes | List of signers required for the template |
| Fields | form | array | Yes | List of fields required for the template |
| ClientReference | form | string | No | client side referese; e.g. external id etc. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SignerReference | form | string | No | Signer reference |
| IsFaceToFaceSigning | form | bool | No | |
| VideoConfirmationEnabled | form | bool | No | |
| ReviewBeforeSigningEnabled | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MobileNumber | form | string | No | Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc |
| MobileCountry | form | string | No | Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc |
| ShareUsers | form | List<ShareUser> | No | |
| ClientReference | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FirstName | form | string | Yes | First name of user |
| MiddleName | form | string | No | Middle name of user |
| LastName | form | string | Yes | Last name of user |
| form | string | Yes | Email address of user |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IsDefault | form | bool | No | |
| IsOwner | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Label | form | string | Yes | Field label |
| Value | form | string | Yes | Field value |
| FieldType | form | string | Yes | Field typeAllowable Values
|
| IsRequired | form | boolean | Yes | If field is mandatory |
| ID | form | string | Yes | Field reference; Obsolated, use Reference instead. |
| Reference | form | string | Yes | Field reference; |
| ReadOnly | form | boolean | Yes | If field is readonly |
| ClientField | form | boolean | Yes | Field name on client side |
| Name | Value | |
|---|---|---|
| Text | 0 | |
| MultiLineText | 1 | |
| CheckBox | 3 | |
| RadioButton | 4 | |
| DropDownList | 5 | |
| DateInput | 6 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /FormFiller/GetSignerTemplate/{TemplateReference} HTTP/1.1
Host: api.securedsigning.com
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Name":"String","Reference":"String","Signers":[{"SignerReference":"String","IsFaceToFaceSigning":false,"VideoConfirmationEnabled":false,"ReviewBeforeSigningEnabled":false,"MobileNumber":"String","MobileCountry":"String","ShareUsers":[{"IsDefault":false,"IsOwner":false,"FirstName":"String","MiddleName":"String","LastName":"String","Email":"String"}],"ClientReference":"String","FirstName":"String","MiddleName":"String","LastName":"String","Email":"String"}],"Fields":[{"Label":"String","Value":"String","FieldType":"Text","IsRequired":false,"ID":"String","Reference":"String","ReadOnly":false,"ClientField":"String"}],"ClientReference":"String"}