Dokumentation av API som anslutna aktörer behöver tillhandahålla för interaktion med Fullmaktskollen

För att integrera med Fullmaktskollens tjänster krävs det att ett tjänstegränssnitt implementeras hos den anslutna aktören. Tjänstegränssnittet ska vara REST.

Nedan beskrivs tjänstegränssnittet för respektive systemroll. För anslutna fullmaktshavare ska metoderna under ”Agent” implementeras, medan anslutna BKP:er implementerar tjänsterna under ”PresenteeParty”.

⬇️ Schemafiler för anslutna aktörers gränssnitt.

Agent

Ett system som har en integration mot Fullmaktskollen i rollen som Agent ska implementera tjänsten ReceiveNotification för att kunna ta emot meddelanden från Fullmaktskollen.

POST ReceiveNotification

Metoden anropas från Fullmaktskollen för att pusha ut notifieringar till en fullmaktshavares integrerade system vid händelser på en fullmakt.

Request Information

URI Parameters

None

Body Parameters

Name	Description	Type
Identity	ID på fullmakten som notifieringen gäller för.	string
Type	Typ av notifiering	AgentNotificationType
Reason	Orsak till notifiering	AgentPOARecallReason

Request Formats

text/xml, application/xml

Sample request

<AgentNotificationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.fullmaktskollen.se/">
	<Identity>0a3ce949-0681-4658-bd5a-e696f5dda6bc</Identity>
	<Type>POASigned</Type>
	<Reason i:nil="true" />
</AgentNotificationRequest>

Response Information

Resource Description

HTTP 200 OK – The request has succeeded.

AgentNotificationType

Name	Value	Description
POASigned	1	A new POA has been signed
POARecalled	2	The POA has been recalled
POADisabled	3	The POA has been disabled
POAAboutToExpire	4	The POA is about to expire
POAExpired	5	The POA has expired
POACompletionListUpdated	6	The CompletionList content of the POA has been changed
POADeleted	7	The POA has been deleted

AgentPOARecallReason

Name	Value	Description
GrantorChangedDate	1	The system recalled the POA due to a change of validity
GrantorRecalled	2	The Grantor recalled the POA
ScannedPOA	3	The POA was signed on paper and scanned
POATransfer	4	The POA was transferred to another Agent

PresenteeParty

Ett system som har en integration mot Fullmaktskollen i rollen som PresenteeParty (BKP) ska implementera tjänsterna

IsCustomer – ta emot och besvara kundfråga
ReceivePOA – ta emot information om en fullmakt
ReceiveNotification – ta emot information om händelser på en fullmakt

för att kunna ta emot meddelanden från Fullmaktskollen.

POST IsCustomer

Metoden anropas från Fullmaktskollen för att ställa en fråga (kundfråga eller portvaktsfråga) till BKP:n om personen eller organisationen är kund hos BKP. Om BKP:n svarar ja på kundfrågan så skickas ett meddelande om fullmakt till BKP:n (ReceivePOA). Om svaret på kundfrågan är nej så skickas ingen mer information från Fullmaktskollen.

Request Information

URI Parameters

None

Body Parameters

Name	Description	Type
CustomerType	Type of customer	PresenteePartyCustomerType
Number	Person- or OrganizationNumber	string

Request Formats

text/xml, application/xml

Sample request

<PresenteePartyIsCustomerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.fullmaktskollen.se/">
	<CustomerType>Individual</CustomerType>
	<Number>196211262834</Number>
</PresenteePartyIsCustomerRequest>

Response Information

Resource Description

Reply to the IsCustomer question

PresenteePartyIsCustomerResponse

Name	Description	Type
CustomerType	Type of customer	PresenteePartyCustomerType
IsCustomer	Is it a customer?	boolean
Number	Person- or OrganizationNumber	string

Request Formats

text/xml, application/xml

Sample response

<PresenteePartyIsCustomerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.fullmaktskollen.se/">
	<CustomerType>Individual</CustomerType>
	<IsCustomer>true</IsCustomer>
	<Number>196409294698</Number>
</PresenteePartyIsCustomerResponse>

PresenteePartyCustomerType

Name	Value	Description
Individual	0	Client is an individual
Organization	1	Client is an organization

POST ReceivePOA

Den här metoden anropas från Fullmaktskollen för att skicka information om en fullmakt till BKPn.

Request Information

URI Parameters

None

Body Parameters

Name	Description	Type	Notes
AdditionalInformation	Övrig affärsinformation, kan innehålla upp till 100 tecken.	string	String length 0 – 255
Agent	Information om fullmaktshavaren	PresenteePartyPOAAgent
Code	Förmedlarkod	string
CompletionList	Personer som inkluderas eller exkluderas från en fullmakt.	PresenteePartyPOACompletionList
Signees	Anger vilka personer som ska skriva under fullmakten och status för signaturen.	Collection of PresenteePartyPOASignee
Organization	Information om organisationen (enbart för organisationsfullmakter).	PresenteePartyPOAOrganization	Only for organization POAs
POAId	ID:t på fullmakten.	globally unique identifier
SignatureType	Anger på vilket sätt fullmakten har signerats.	PresenteePartyPOASignatureType
Type	Typ av fullmakt	PresenteePartyPOAType
ValidFrom	Tidpunkten fullmakten är giltig från	date (UTC)
Validity	Typ av giltighetstid.	PresenteePartyPOAValidityType
ValidTo	Tidpunkten fullmakten är giltig till	date (UTC)
ExternalReference	Referens ID för externt lagrad fullmakt	string
TextVersion	Version av fullmaktstexten	integer
ReplacedPOAId	Unikt id för ersatt fullmakt om sådan existerar	globally unique identifier

Request Formats

text/xml, application/xml

Sample request – InformationPrivate POA

<PresenteePartyPOARequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.fullmaktskollen.se/">
	<AdditionalInformation></AdditionalInformation>
	<Agent>
		<Name>Pensionsrådgivarna AB</Name>
		<OrganizationNumber>165566778899</OrganizationNumber>
		<Contact1>
			<Email>johan.pehrsson@pensionsradgivarna.se</Email>
			<FirstName>Johan</FirstName>
			<LastName>Pehrsson</LastName>
		</Contact1>
		<Contact2 i:nil="true" />
	</Agent>
	<Code>12345</Code>
	<CompletionList i:nil="true" />
	<Signees>
		<PresenteePartyPOASignee>
			<CivicRegistrationNumber>196211262834</CivicRegistrationNumber>
			<FirstName>Nils</FirstName>
			<LastName>Karlsson</LastName>
			<Signed>2023-06-01T13:45:20.303</Signed>
		</PresenteePartyPOASignee>
	</Signees>
	<POAId>0d004f16-5efa-4c04-bfbb-e6139c00f14f</POAId>
	<SignatureType>Digital</SignatureType>
	<Type>InformationPrivate</Type>
	<ValidFrom>2023-06-01T13:45:20.303</ValidFrom>
	<Validity>UntilFurtherNotice</Validity>
	<ValidTo i:nil="true" />
	<TextVersion>1</TextVersion>
</PresenteePartyPOARequest>

Sample request – InformationOrganisation POA

<PresenteePartyPOARequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.fullmaktskollen.se/">
	<Agent>
		<Name>Pensionsrådgivarna AB</Name>
		<OrganizationNumber>165566778899</OrganizationNumber>
		<Contact1>
			<Email>johan.pehrsson@pensionsradgivarna.se</Email>
			<FirstName>Johan</FirstName>
			<LastName>Pehrsson</LastName>
		</Contact1>
		<Contact2 i:nil="true" />
	</Agent>
	<Code />
	<CompletionList>
		<People />
		<Type>All</Type>
	</CompletionList>
	<Signees>
		<PresenteePartyPOASignee>
			<CivicRegistrationNumber>196211262834</CivicRegistrationNumber>
			<FirstName>Nils</FirstName>
			<LastName>Karlsson</LastName>
			<Signed>2023-06-01T13:45:20.303</Signed>
		</PresenteePartyPOASignee>
	</Signees>
	<Organization>
		<Name>Plastfabriken AB</Name>
		<Number>163344556677</Number>
	</Organization>
	<POAId>5f764bd4-c84f-46fb-9ef5-205758f486c4</POAId>
	<SignatureType>Digital</SignatureType>
	<Type>MaintenanceOrganization</Type>
	<ValidFrom>2023-06-01T13:45:20.303</ValidFrom>
	<Validity>Timespan</Validity>
	<ValidTo>2023-12-31</ValidTo>ValidTo>
	<TextVersion>1</TextVersion>
</PresenteePartyPOARequest>

Response Information

Resource Description

HTTP 200 OK – The request has succeeded.

PresenteePartyPOAAgent

Name	Description	Type
Name	För- och efternamn eller fullständigt organisationsnamn.	string
OrganizationNumber	Organisationsnummer	string
Contact1	Kontaktperson 1 hos fullmaktshavare	PresenteePartyPOAAgentContact
Contact2	Kontaktperson 2 till fullmaktshavare	PresenteePartyPOAAgentContact

PresenteePartyPOAAgentContact

Name	Description	Type
Email	Epost	string
FirstName	Förnamn	string
LastName	Efternamn	string

PresenteePartyPOACompletionList

Name	Description	Type	Notes
People	Personer som inkluderas eller exkluderas från fullmakten.	Collection of PresenteePartyPOACompletionListPerson
Type	Anger om fullmakten gäller alla, bara visas anställda eller undantar anställda.	PresenteePartyPOACompletionListType

PresenteePartyPOACompletionListPerson

Name	Description	Type
CivicRegistrationNumber	Personnummer	string
FirstName	Förnamn	string
LastName	Efternamn	string

PresenteePartyPOACompletionListType

Name	Value	Description
All	1	Fullmakten gäller alla
Include	2	Fullmakten gäller bara angivna personer
Exclude	3	Fullmakten gäller alla utom angivna personer

PresenteePartyPOASignee

Name	Description	Type
CivicRegistrationNumber	Personnummer	string
FirstName	Förnamn	string
LastName	Efternamn	string
Signed	Tidsstämpel för signatur	date

PresenteePartyPOAOrganization

Name	Description	Type	Notes
Name	Organisationens namn	string
Number	Organisationsnummer	string

PresenteePartyPOASignatureType

Name	Value	Description
Digital	1	En fullmakt vars digitala signatur finns lagrad i fullmaktskollen
Image	2	En inscannad fullmakt
External	3	En digital fullmakt vars signatur finns lagrad hos tredje part

PresenteePartyPOAType

Name	Value	Description
InformationPrivate	1	Informationsfullmakt, privat
MaintenancePrivate	2	Förmedlingsfullmakt, privat
InformationOrganization	3	Informationsfullmakt, organisation
MaintenanceOrganization	4	Förmedlingsfullmakt, organisation

PresenteePartyPOAValidityType

Name	Value	Description
Timespan	1	Ett angivet tidsintervall
NumberOfDays	2	Ett visst antal dagar efter signering
UntilFurtherNotice	3	Tills vidare

POST ReceiveNotification

Den här metoden anropas från Fullmaktskollen för att skicka meddelanden om händelser på en fullmakt till en BKP.

Request Information

URI Parameters

None

Body Parameters

Name	Description	Type
Identity	ID på objektet notifieringen gäller för. Det kan t.ex. vara ID för en fullmakt.	string
Type	Typ av händelse	PresenteePartyNotificationType
Reason	Orsak till händelsen	PresenteePartyPOARecallReason

Request Formats

text/xml, application/xml

Sample request

<PresenteePartyNotificationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.fullmaktskollen.se/">
	<Identity>0a3ce949-0681-4658-bd5a-e696f5dda6bc</Identity>
	<Type>POARecalled</Type>
	<Reason>GrantorChangedDate</Reason>
</PresenteePartyNotificationRequest>

Response Information

Resource Description

HTTP 200 OK – The request has succeeded.

PresenteePartyNotificationType

Name	Value	Description
POASigned	1	En fullmakt har signerats
POARecalled	2	En fullmakt har återkallats
POADisabled	3	En fullmakt har inaktiverats
POAExpired	4	En fullmakts giltighetstid har löpt ut
POACompletionListUpdated	5	Fullmaktens begränsningar har ändrats

PresenteePartyPOARecallReason

Name	Value	Description
GrantorChangedDate	1	Systemet har återkallats på grund av att ändrad giltighetstid
GrantorRecalled	2	Fullmaktsgivaren har återkallat fullmakten
POATransfer	3	Fullmakten har överlåtits till en annan fullmaktshavare