signatures
Introduced in version 25.591
Create signature case
Creates a contract and sends it to Assently for signing. Returns url to the document. If the provided subscription has a different payer than user and is of type autogiro, two contracts till be created.
Call
HTTP POST to /signatures
Filter
Name | Required | Example value | Description | Value/datatype | Default |
|---|---|---|---|---|---|
| subscriptionid | yes | 14 | ID for the subscription to be signed | ID | - |
| language | no | sv | Selected language for the contract. The value must be expressed using ISO 639 (two character language code). | String | |
| returnurl | no | http://www.mysite.se/subscriptionsigned/14?hash=3327468723647637463746 | String | - | |
| onlydirectdebitconsent | no | true | In only the page containing the direct debit consent should be included in the document to sign. | boolean | false |
Example:
POST:APIURL/signatures.json?apikey=338934897438&subscriptionid=14&returnurl=http://www.mysite.se/subscriptionsigned/14?hash=3327468723647637463746
Return values
Tag | Format | Example | Desription |
|---|---|---|---|
| signaturecases | signaturecases-tag surrounds all signature cases | ||
| signaturecase | one signature case | ||
| id | ID | <id>7</id> | Unique ID to the case in BRP |
| guid | TEXT | <guid>1234234-234234-234234-23423</guid> | Unique ID of the case at egree |
| documenturl | Text | <documenturl>https://www.egree.com/8974897234892398489234</documenturl> | The documents to sign |
| Text | <email>carl.duck@gmail.com</email> | E-mail to the person to sign | |
| name | Text | <name>Carl Duck</name> | Name of the person to sign |
<signaturecases> <signaturecase> <id>7</id> <guid>1234234-234234-234234-23423</guid> <documenturl>https://www.egree.com/8974897234892398489234</documenturl> <email>knatte.duck@gmail.com</email> <name>Knatte Duck</name> </signaturecase> <signaturecase> <id>8</id> <guid>12344234-2343-234344-23423</guid> <documenturl>https://www.egree.com/89748972345465466549234</documenturl> <email>carl.duck@gmail.com</email> <name>Carl Duck</name> </signaturecase> </signaturecases>