Tidvis Sign Public API

Krav

• Kontoen skal ha planen Sign Pro og tillegget MitID aktivert.
• Pris: 100 MitID-signaturer inkludert per måned, deretter 5 SEK/signatur.
• Uten tillegget returnerer POST /agreements/:id/lifecycle med action: "send" feilen 402 bankid_disabled.

Opprett MitID-aftale

curl -X POST https://tidvis.se/api/public/v1/agreements \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Arbeidsavtale Anna",
    "bankid_required": true
  }'

Svar (forkortet):

{
  "id": "agr_...",
  "status": "draft",
  "bankid_required": true,
  "document": { "uploaded": false, "sha256": null },
  "participants": []
}

Webhook-payload når MitID bruges

For aftaler med bankid_required: true berikes agreement.signed-hendelsen med en signature-blokk. Av personvernhensyn eksponeres verken personnummer, sertifikater eller OCSP-svar via API-et eller webhooks.

{
  "event": "agreement.signed",
  "agreement_id": "agr_...",
  "participant": { "id": "p_...", "email": "anna@example.com" },
  "signature": {
    "method": "bankid",
    "signer_name": "Anna Andersson",
    "signed_at": "2026-06-11T08:42:11.000Z"
  }
}

Feltet signature.method er alltid en av "otp_email" eller "bankid". Avtaler med blandede deltakere logger metoden per signatar.

Slå på ved opprettelse

curl -X POST https://tidvis.se/api/public/v1/agreements \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "NDA Anna",
    "bankid_identify_required": true
  }'

Svar (forkortet):

{
  "id": "agr_...",
  "status": "draft",
  "bankid_required": false,
  "bankid_identify_required": true,
  "participants": []
}

Atferd for mottakeren

• Når mottakeren åpner lenken vises en MitID-gate i stedet for PDF-en.
• Mottakeren skal starte MitID på mobil eller via QR-kode og bekrefte legitimeringen.
• Først deretter åpnes PDF-en og valgt signaturmetode bliver aktiv.
• "viewed"-hendelsen logges etter legitimeringen, ikke ved første klik på lenken.

Krav og pris

• Kontoen skal ha Sign Pro og tillegget MitID aktivert — samme krav som bankid_required.
• Identifiseringer teller ikke mot MitID-kvoten på 100 signeringer/mnd. Kun faktiske MitID-signeringer (bankid_required: true) debiteres 5 SEK/stk ut over inkluderte.
• Uten tillegget returnerer POST /agreements/:id/lifecycle med action: "send" feilen 402 bankid_disabled.

Webhook-payload

En egen hendelse agreement.identified sendes når en mottaker har legitimert seg. Personnummer, sertifikater og OCSP-svar eksponeres aldri via API-et.

{
  "event": "agreement.identified",
  "agreement_id": "agr_...",
  "participant": { "id": "p_...", "email": "anna@example.com" },
  "identification": {
    "method": "bankid",
    "signer_name": "Anna Andersson",
    "identified_at": "2026-06-12T10:21:04.000Z"
  }
}