POA

Hämta och lagra information om fullmakter.

API Description
POST api/v1/POA/Search

Sök ut en delmängd av fullmaktsbeståndet. Använd "List" för att iterera över hela beståndet. Fullmaktshavare kan söka på fullmakter de själva äger, BKP:er kan söka på signerade fullmakter där en kundfråga ställts eller ska ställas till dem.
POST api/v1/POA/SearchCustomerResponse

Lista mottagna kundfrågor för en person eller organisation.
POST api/v1/POA/List

Lista fullmaktsbestånd. För fullmaktshavare listas fullmakter de själva äger, för BKP:er listas fullmakter där BKP:n svarat ja på kundfrågan och har en prenumeration på förändringar.
POST api/v1/POA/Disable

Inaktivera en fullmakt.
POST api/v1/POA/Get?showLanguageCode={showLanguageCode}

Hämta information om en fullmakt utifrån fullmaktens unika identitet. Lägg till URL-parameter för att inkludera språkkod i svaret.
POST api/v1/POA/GetLatestId

Hämta identiteten för den senaste versionen av fullmakten. En ny version av fullmakten skapas t ex vid ändring av giltighetstid eller vid överlåtelse och varje version har en egen identitet.
POST api/v1/POA/GetText?asHtml={asHtml}&asXml={asXml}&showExtendedInfo={showExtendedInfo}

Hämta fullmaktstexten för en given fullmakt.
GET api/v1/POA/GetTexts?asHtml={asHtml}&asXml={asXml}&showExtendedInfo={showExtendedInfo}

Lista alla tillgängliga fullmaktstexter.
POST api/v1/POA/Create

Skapa en fullmakt för underskrift.
POST api/v1/POA/Resend

Skicka om fullmakten till valda BKP:er. Skickar en ny kundfråga, inväntar svar och därefter fullmakten vid ett ja-svar från BKP:n. Funktionen är att betrakta som synkron och ska inte anropas parallellt.
POST api/v1/POA/Edit

Ändra kontaktuppgifter, uppgifter om fullmaktsgivaren, mottagare eller koder på en osignerad fullmakt.
POST api/v1/POA/Events

Hämta ut händelseinformation för fullmakter (ersatt av EventLog).
GET api/v1/POA/GetListOfActorAllowedEventTypes

Hämta ut vilka filter för händelselogg som anropande system har rätt att använda.
POST api/v1/POA/EventLogWeb

No documentation available.
POST api/v1/POA/EventLog

Detaljerad händelselogg för en given fullmakt. Ange om alla versioner av fullmakten ska inkluderas, vilka typer av händelser som ska returnas och om svaret bara ska avse ett givet tidsintervall.
POST api/v1/POA/EventLogMini

Minimal händelselogg som enbart returnerar datum och en beskrivning för alla versioner av en fullmakt. Returnerar alla händelser som frågande system har behörighet till.
POST api/v1/POA/Responses

Hämta ut svar på de kundfrågor som skickats till BKP:er.
POST api/v1/POA/GetRecipientInformation

Hämta ut svar på de kundfrågor som skickats till BKP:er vid en given tidpunkt. Om tidpunkt inte är angiven hämtas senaste skicka-tillfället för varje BKP.
POST api/v1/POA/Delete

Ta bort en fullmakt som inte har skrivits under.
POST api/v1/POA/Store

Registrera en fullmakt som har signerats i ett system hos t ex en fullmaktshavare.
POST api/v1/POA/Replace

Ersätt en osignerad fullmakt.
POST api/v1/POA/History

Lista historik för en fullmakt. Inkluderar alla versioner av fullmakten.
POST api/v1/POA/GetPOAsForCustomer

Listar fullmakter för en fullmaktsgivare, person eller organisation.
POST api/v1/POA/SendReminder

Skicka påminnelse om osignerad fullmakt till fullmaktsgivare.

Agent

Funktioner för Fullmaktshavare.

API Description
GET api/v1/Agent/List

Lista samtliga fullmaktshavare i tjänsten.
POST api/v1/Agent/SearchContact

Söker fullmakt baserat på angiven kontaktuppgift.
POST api/v1/Agent/ListUniqueContacts

Listar alla unika kontaktuppgifter.
POST api/v1/Agent/SearchCode

Söker fullmakt baserat på angiven kod.
POST api/v1/Agent/SearchCode2

Söker fullmakt baserat på angiven kod. Returnerat svar innehåller mer data om fullmakterna än i SearchCode.
POST api/v1/Agent/ListUniqueCodes

Listar de senaste unika koderna för en viss BKP.
POST api/v1/Agent/QueryFirstContact

Listar kontaktuppgift 1.
POST api/v1/Agent/QuerySecondContactsBasedOnSelectedFirstContact

Listar kontaktuppgift 2 som matchar kontaktuppgift 1.
POST api/v1/Agent/QueryPoaRecipientsByContacts

Söker mottagare baserad på fullmaktens kontakter.
POST api/v1/Agent/QueryPoaCodeByRecipient

Söker kod baserad på fullmaktens mottagare.
POST api/v1/Agent/QuerySearchPoas

Söker fullmakter.

Authorization

API Description
GET api/v1/Authorization/Identity

Verifiera kopplingen till API:et och säkerställ det frågande systemets identitet.

PresenteeParty

Funktioner relaterade till behörighetskontrollerande parter.

API Description
GET api/v1/PresenteeParty/List

Lista samtliga behörighetskontrollerande parter som finns tillgängliga i tjänsten.
POST api/v1/PresenteeParty/SetIsCustomer

Lämna ett nytt svar på en redan besvarad kundfråga utifrån fullmaktens identitet. Ändrar svaret enbart för angiven fullmakt.
GET api/v1/PresenteeParty/SetIsCustomer?grantorNumber={grantorNumber}&isCustomer={isCustomer}&resendValidPoas={resendValidPoas}

Lämna ett nytt svar på en redan besvarad kundfråga utifrån ett person- eller organisationsnummer. Svaret ändras för alla gällande fullmakter på angivet person- eller organisationsnummer. Genom att ange true i resendValidPoas-parametern så skickas fullmakten till mottagande BKPs system som ett PresenteePartyPOARequest-meddelande på samma sätt som om kundfrågan hade besvarat med true vid första tillfället.
POST api/v1/PresenteeParty/UnsubscribeCustomer

Avsluta prenumerationen för samtliga gällande fullmakter för en given fullmaktsgivare.
POST api/v1/PresenteeParty/ManageSubscription

Uppdatera prenumerationsstatus för en specifik fullmakt.

Report

Funktioner för att hämta rapporter med detaljer om fullmaktsinnehav.

API Description
GET api/v1/Report/Download

Ladda ner en rapport, en CSV-fil innehållande fullmaktsinnehavet genereras vid anrop.
POST api/v1/Report/Download

Ladda ner en rapport med ett visst urval av fullmakter. En CSV-fil innehållande fullmaktsinnehavet genereras vid anrop.