API-basert signering

Slik setter du opp signering via API.

Hva er API-basert signering?

Du kan bruke signeringsfunksjonaliteten via API-kall uten å bruke brukergrensesnittet i Altinn.

Avhengigheter

Hvis appen skal sende signeringskvittering til innboksen til den som signerer, må meldingstjenesten i Altinn være satt opp.

Sette opp signering

Se veiledningene for å sette opp signering. API-basert signering har samme krav til oppsett, bortsett fra at sidene for signeringssteget kan være enklere.

De sentrale API-kallene

Utføre enkeltsignering

Hvis bare én person skal signere i et signeringssteg, kan du bruke «process next»-endepunktet:
PUT /{org}/{app}/instances/{instanceOwnerPartyId}/{instanceGuid}/process/next

Body:

{
  "action": "sign"
}

Da går prosessen automatisk videre etter at signaturen er lagret. Hvis du bruker dette API-endepunktet, må du ha flere signeringssteg hvis flere skal signere.

Utføre parallellsignering

Hvis du vil at flere skal signere parallelt, må du bruke følgende endepunkt i stedet for «process next»:
POST /{org}/{app}/instances/{instanceOwnerPartyId}/{instanceGuid}/actions

Body:

{
  "action": "sign"
}

Da blir prosessen stående i signeringssteget, og flere kan signere før prosessen dras videre med et «process next»-kall.

Informasjon om de som skal signere og signaturer

Hvis brukerstyrt signering er satt opp, kan du bruke følgende API-endepunkt for å hente ut en liste med de som skal signere (signatarer) og deres signeringsstatus. Du kan også bruke API-endepunktet selv om du ikke bruker brukerstyrt signering, men da listes bare de som allerede har signert ut. Det fungerer da som en signaturliste.
GET /{org}/{app}/instances/{instanceOwnerPartyId}/{instanceGuid}/signing

Eksempel på respons før signering er utført, der en person og en virksomhet skal signere:

{
  "signeeStates": [
    {
      "name": "BØYLEHEST MATT",
      "organisation": null,
      "delegationSuccessful": true,
      "notificationStatus": "Sent",
      "partyId": 51281269,
      "signedTime": null
    },
    {
      "name": null,
      "organisation": "LYDIG VENNLIG KATT KJERNE",
      "delegationSuccessful": true,
      "notificationStatus": "Sent",
      "partyId": 51843877,
      "signedTime": null
    }
  ]
}

Etter signering (her har Bøylehest Matt signert på vegne av seg selv, og Fisk Kunstig på vegne av organisasjonen Lydig Vennlig Katt Kjerne):

{
  "signeeStates": [
    {
      "name": "BØYLEHEST MATT",
      "organisation": null,
      "delegationSuccessful": true,
      "notificationStatus": "Sent",
      "partyId": 51281269,
      "signedTime": "2025-03-03T11:16:02.9390324Z"
    },

    {
      "name": "FISK KUNSTIG",
      "organisation": "LYDIG VENNLIG KATT KJERNE",
      "delegationSuccessful": true,
      "notificationStatus": "Sent",
      "partyId": 51843877,
      "signedTime": "2025-03-03T11:18:25.9518554Z"
    }
  ]
}