Beskrivning

Hämtar bolagengagemang för en privatperson från Bolagsverket samt bolagsinformation för ett specifikt bolag.

I steg två skall tjänsten byggas ut mot Bolagsverkets Mina Ombud.

Alla lyckade svar från bolagsverket cachas i 30 minuter.

Livscykelstatus

I produktion

Lösningsbeskrivning

Gliffy

...

Hantering av personuppgifter

API specifikation

Expand

title	API-nyckel mot sandbox, klicka på "Authorize" och klistra in denna:

eyJ4NXQiOiJPV1l4TkRJd016ZGhPREk1WVdRNU1EZGxPREkzT1RZeU1qTXpZemN4TW1NMU0yRTFaREF5WXpGa01qQmpNV0ZrTkROa1pXVTFPRFk1T1dJMlpHRTBZZyIsImtpZCI6ImdhdGV3YXlfY2VydGlmaWNhdGVfYWxpYXMiLCJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJQRVJTT05BTFwvV1NPMl9NU19zaWduYXRvcnlAY2FyYm9uLnN1cGVyIiwiYXBwbGljYXRpb24iOnsib3duZXIiOiJQRVJTT05BTFwvV1NPMl9NU19zaWduYXRvcnkiLCJ0aWVyUXVvdGFUeXBlIjpudWxsLCJ0aWVyIjoiVW5saW1pdGVkIiwibmFtZSI6IkRlZmF1bHRBcHBsaWNhdGlvbiIsImlkIjoyNSwidXVpZCI6ImYwZDU4MTc3LWVlNzctNDNjOC1iNDM0LTBmNDQyOTBkMWU5ZiJ9LCJpc3MiOiJodHRwczpcL1wvYXBpLWltLXRlc3Quc3VuZHN2YWxsLnNlOjQ0M1wvb2F1dGgyXC90b2tlbiIsInRpZXJJbmZvIjp7IkJyb256ZSI6eyJ0aWVyUXVvdGFUeXBlIjoicmVxdWVzdENvdW50IiwiZ3JhcGhRTE1heENvbXBsZXhpdHkiOjAsImdyYXBoUUxNYXhEZXB0aCI6MCwic3RvcE9uUXVvdGFSZWFjaCI6dHJ1ZSwic3Bpa2VBcnJlc3RMaW1pdCI6MCwic3Bpa2VBcnJlc3RVbml0IjpudWxsfSwiVW5saW1pdGVkIjp7InRpZXJRdW90YVR5cGUiOiJyZXF1ZXN0Q291bnQiLCJncmFwaFFMTWF4Q29tcGxleGl0eSI6MCwiZ3JhcGhRTE1heERlcHRoIjowLCJzdG9wT25RdW90YVJlYWNoIjp0cnVlLCJzcGlrZUFycmVzdExpbWl0IjowLCJzcGlrZUFycmVzdFVuaXQiOm51bGx9fSwia2V5dHlwZSI6IlNBTkRCT1giLCJwZXJtaXR0ZWRSZWZlcmVyIjoiIiwic3Vic2NyaWJlZEFQSXMiOlt7InN1YnNjcmliZXJUZW5hbnREb21haW4iOiJjYXJib24uc3VwZXIiLCJuYW1lIjoiQnVzaW5lc3NFbmdhZ2VtZW50cyIsImNvbnRleHQiOiJcL2J1c2luZXNzZW5nYWdlbWVudHNcLzEuMCIsInB1Ymxpc2hlciI6IlBFUlNPTkFMXC9tYXIxNGhhbiIsInZlcnNpb24iOiIxLjAiLCJzdWJzY3JpcHRpb25UaWVyIjoiQnJvbnplIn0seyJzdWJzY3JpYmVyVGVuYW50RG9tYWluIjoiY2FyYm9uLnN1cGVyIiwibmFtZSI6IkNpdGl6ZW5NYXBwaW5nIiwiY29udGV4dCI6IlwvY2l0aXplbm1hcHBpbmdcLzEuMCIsInB1Ymxpc2hlciI6IlBFUlNPTkFMXC9qb2UxNGxpbiIsInZlcnNpb24iOiIxLjAiLCJzdWJzY3JpcHRpb25UaWVyIjoiVW5saW1pdGVkIn0seyJzdWJzY3JpYmVyVGVuYW50RG9tYWluIjoiY2FyYm9uLnN1cGVyIiwibmFtZSI6IkxlZ2FsRW50aXR5IiwiY29udGV4dCI6IlwvbGVnYWxlbnRpdHlcLzEuMCIsInB1Ymxpc2hlciI6IlBFUlNPTkFMXC9qb2UxNGxpbiIsInZlcnNpb24iOiIxLjAiLCJzdWJzY3JpcHRpb25UaWVyIjoiVW5saW1pdGVkIn1dLCJwZXJtaXR0ZWRJUCI6IiIsImlhdCI6MTY2MDcyMDE3NiwianRpIjoiM2Q3ZDYxZTgtMzY3YS00YTgwLWJjNDItM2M5N2Y5MjQzNjVkIn0=.rOzKm1CCSVC8PYy5Rb1hOOkDWtNgxMOrBnXUPo1g1u2k8yAoAzPHjskzbXgUdllXFNiJSnDTYg4imGnUv_4o6OF4yoCALLD31OxbmSkosYLnZ-hnVZToZ42mnouIuwsmaTTnuEZSa3GB3eL3K9k5NnjZu-hw_jvAN10cekvYp5JLMDUNI6STPMEtMCXo_jiB-UYbisgUh-2JWSBGgciE_wnakaMFUZKpamHpdHw93B415RzXR5dUJTebVKvafo8oASgO5MElYdBVBretrdmZXipaLYL5b7xObmqokx1MmqhFA_7iyvuLH9csjdYQTrZjG1vmj5LV4pGUDTXofYaC-A==

...

Hantering av personuppgifter

API specifikation

Open api

showCommonExtensions	true
deepLinking	true
supportedSubmitMethods	none
location	url
showExtensions	true
url	https://api-test.sundsvall.se/businessengagements/

...

api-docs

Hämta företagsengagemang (/engagements/{partyId})

Request: /engagements/6a5c3d04-412d-11ec-973a-0242ac130003?personalName=Jane%20Doe&serviceName=Kommunen

Response:

Code Block

language	json

Förtydligande response-parametrar:

engagements: Kan innehålla 0 → n antal engagemang personen har, varje objekt innehåller organisationsnamn och organisationsnummer.
- organizationId: unikt uuid/guid för organisationsnumret, om det inte återfinns i LegalEntity utelämnas denna helt.
statusDescriptions: Innehåller eventuella fel i samband med hämtandet av bolagsengagemang eller organizationId. T.ex. att underliggande system (från bolagsverket) överskred begärd svarstid eller att det inte gick att hämta organizationId. Typen är en “Map<String, String>”.
status: Visar om personens alla engagemang kunde hämtas utan fel. Vid eventuella fel sätts denna till “NOK” och det reflekteras även i parametern statusDescriptions genom att varje felbeskrivning läggs till.

Hämta företagsinformation (/information/{partyId})

Request: /information/6a5c3d04-412d-11ec-973a-0242ac130003?organizationName=Testbusiness

Response:

Code Block

language	json

Beroende på svaret från Bolagsverket kan det saknas information i en eller flera fält.
Istället för att invalidera hela svaret indikeras det att information inte är komplett / kunde hämtas från bolagsverket i errorInformation-fältet, med tillhörande felmeddelande om varför information inte gick att hämta.
errorDescription är en Map där nyckeln är felkoden och värdet är felbeskrivningen från bolagsverket.

Testdata

Bolagsverket har lagt upp fiktiva personnummer med olika bolagsengagemang, partyId för dessa personer finns upplagda i testmiljön för CitizenMapping och mappar till följande dokument.

Personnummer	partyId
198104112381	65694a6d-5f5d-4bb6-b256-3b81cb419b60
198101032384	d1eda732-5aec-45e2-a673-4debd42b2f04
198101052382	d4554399-91bb-4258-a7a7-afb9f265dd66
198101012386	740c013c-f979-4ad3-a073-42a6d5255e3a
198101042383	5a4afbf9-8897-42a8-aaf0-de9530849f7c
193403223328	af99121e-4dfc-477c-8b02-daf70603b55f
198104152387	ea4a0b53-fa9a-42a6-89a6-7ab1431a014f

Säkerhetsklassning

Säkerhetsklass 1

Autentiseringsmetod: Oauth2

(Ref: Säkerhetsklassning av APIer )

API-ägare

N/A

Teknisk ägare

API-teamet

Ansvarigt team: Team Unmasked

För tekniska frågor: t eamunmasked@sundsvall.se

Version	Old Version 53	New Version Current
Changes made by	Jakob Melander	Publisher User Atlassian Cloud
Saved on	Jan 18, 2023	Mar 27, 2024

Versions Compared

Key

Beskrivning

Livscykelstatus

Lösningsbeskrivning

Hantering av personuppgifter

API specifikation

Hantering av personuppgifter

API specifikation

Hämta företagsengagemang (/engagements/{partyId})

Hämta företagsinformation (/information/{partyId})

Testdata

Säkerhetsklassning

API-ägare

Teknisk ägare

Länkar

Content Comparison

Versions Compared

Key

Beskrivning

Livscykelstatus

Lösningsbeskrivning

Hantering av personuppgifter

API specifikation

Hantering av personuppgifter

API specifikation

Hämta företagsengagemang (/engagements/{partyId})

Hämta företagsinformation (/information/{partyId})

Testdata

Säkerhetsklassning

API-ägare

Teknisk ägare

Länkar