Settings-endpointen används för att tala om för Upsales vilka alternativ din e-signeringstjänst har för användaren när vyn ”Skapa E-sign” öppnas.

Endpoint

POST https://yourapp.com/settings

Endpointen måste använda HTTPS.

Body
Anropets body innehåller informationen om vilken användare inställningarna ska gälla för. Oftast är det config-objekten i body.config och body.userConfig.

Svar
Svara med status 200 eller 201. Som standard väntar Upsales 30 sekunder på svaret. Svaret måste vara ett JSON-objekt med följande egenskaper

delivery array
En array med de tillgängliga signeringsalternativen. E-post erbjuds alltid. Ta med "sms" om användaren också ska kunna skicka e-signen via sms.

documentType "pdf" eller "html"
Upsales har två arbetsflöden för E-sign. Om du vill att användaren bara ska arbeta i Upsales och ladda upp PDF:er använder du documentType "pdf". Använd "html" om du vill använda en iFrame för att konfigurera e-signen i ditt system.

allowDraft true/false
Sätt till true om du har stöd för att spara dokumenten som utkast innan de skickas.

multiSign true/false
Sätt till true om du har stöd för att fler än en person signerar.

userCanSign true/false
Sätt till true om du har stöd för signering av användare (och inte bara kontaktpersoner).

bankIdCountries array
De länder där din tjänst har stöd för signering med BankID, som landskoder med två bokstäver. Giltiga värden: "se", "no", "dk". Om arrayen innehåller minst ett land kan användaren välja Ska signera med BankID för varje undertecknare. Lämna den tom om du inte har stöd för BankID.

fields array

Skapa egna fält med den information du vill att Upsales-användare ska fylla i när de skapar en ny e-sign (innan de skickas vidare till din iFrame). Varje fält behöver name, label och type. Ett select-fält listar sina alternativ i data, vart och ett med value och name.

Exempel

[{
  "name": "template",
  "label": "Choose template",
  "type": "select",
  "data": [
    {"value": 1, "name": "Sales agreement"},
    {"value": 2, "name": "NDA"}
  ]
}]

(För närvarande har vi bara stöd för typen 'select')

languages array

En array med språkkoderna (två bokstäver) för de språk som din tjänst har stöd för. Giltiga värden: "sv", "en", "no", "fi", "da", "de".

Exempelsvar

{
  "delivery": ["email", "sms"],
  "documentType": "pdf", 
  "allowDraft": true,
  "userCanSign": true,
  "multiSign": true,
  "bankIdCountries": ["se"],
  "languages": ["en", "de", "sv"]
}