MAGDA Sociale Zekerheid

Inleiding

Diensten gebruikt voor het ophalen van gegevens omtrent een onderneming of vestiging. Het gaat om gegevens uit het KBO, tewerkstellinggegevens en financiële gegevens.

Protocol

Idem als bij alle Magda connectoren.

Applicatie eigenschappen

Algemeen

Opdat de connector toegang zou krijgen tot de MAGDA service, moet deze beschikken over de volgende informatie. De placeholder {service} moet je telkens vervangen door de specifieke service die je wil implementeren.

dosis (legacy connector)
ebox (magda documentendienst)
gc (ondernemingen - giveCompany)
ghp
gp (geefPersoon)
mobility (mobiliteit)
poc (kadaster)
ri (repertorium)
sme (ondernemingen - geefJaarrekeningen)
zoekeigendomstoestanden (kadaster)

URL-endpoint

Eigenschap

Beschrijving

skryv.connectors.magda.{service}.service-url

Geef het URL-endpoint.

Voorbeeld: https://magdapersoondienst.vlaanderen.be

Keys en certificaten

Eigenschap	Beschrijving
`skryv.aws.mutual-ssl.seed.enabled`	Indien `true`, dan haalt de applicatie de key en het certificaat op uit de AWS Secrets Manager en slaat deze lokaal in de applicatie op (zie de twee rijen hieronder). Indien `false`, dan neemt de applicatie rechtstreeks de lokaal gedefinieerde key en certificaat zonder eerst AWS Secrets manager te bevragen.
`aws.{service}.client.ssl.trustore-jks`	Lokale opslag van het certificaat. Voorbeeld: `wrp-trust-store.jks`
`aws.{service}.client.ssl.keystore-jks`	Lokale opslag van de key. Voorbeeld: `wrp-key-store.jks`
`aws.{service}.client.ssl.trust-store-path`	Bevat het pad naar het certificaat in AWS Secrets Manager.
`aws.{service}.client.ssl.private-key-path`	Bevat het pad naar de key in AWS Secrets Manager.
`aws.{service}.client.ssl.private-key-password-path`	Bevat het pad naar het wachtwoord voor de key in AWS Secrets Manager.

Hoedanigheid

Onderstaand is de default voor alle magda services. In de meeste gevallen wordt dit vervangen door een service specifieke eigenschap.

Eigenschap

Beschrijving

magda.default.hoedanigheid

Bevat de aansluitingscode of IPDC-code.

Uri

Onderstaand is de default voor alle magda services. In de meeste gevallen wordt dit vervangen door een service specifieke eigenschap.

Eigenschap

Beschrijving

magda.default.uri

Bevat het pad naar de aan te spreken service.

Sociale zekerheid specifiek

Specifieke applicatie eigenschappen, los van de algemene eigenschappen die de toegang regelen.

Eigenschap	Beschrijving
Geen specifieke eigenschappen.	Geen specifieke eigenschappen.

Services en functies

givefBetalingenHandicap

Vraag voor een persoon gegevens op omtrent uitbetalingen in kader van een handicap.

Workflow expressie 1

Variant waarbij je terugvalt op de default magda aansluitingsgegevens.

${magda.givefBetalingenHandicap(String insz, String startDate, String endDate, String dossierId)}

Input

Inputparameters	Data type	Voorbeeld	Uitleg
insz	String	‘85010212345’	Identificatienummer voor de sociale zekerheid (rijksregisternummer)
startDate	String	‘2020-01-01'	Startdatum referteperiode
endDate	String	‘2025’01-01’	Einddatum referteperiode
dossierId	String (GUID)	-	Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call)

Workflow expressie 2

Variant waarbij de magda aansluitingsgegevens expliciet worden meegegeven.

${magda.givefBetalingenHandicap(String insz, String startDate, String endDate, String uri, String hoedanigheid, String dossierId)}

Input

Inputparameters	Data type	Voorbeeld	Uitleg
insz	String	‘85010212345’	Identificatienummer voor de sociale zekerheid (rijksregisternummer)
startDate	String	‘2020-01-01'	Startdatum referteperiode
endDate	String	‘2025’01-01’	Einddatum referteperiode
uri	String	-	Aansluiting bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda)
hoedanigheid	String	-	IDPC-code, uniek aansluitingsnummer bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda)
dossierId	String (GUID)	-	Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call)

Output

Je krijgt een object GeefBetalingenHandicapResponse terug met uitbetalingsgegevens voor een persoon in kader van een handicap.

Magda-documentatie

Technische documentatie GeefBetalingenHandicap-03.00.

giveDossierHandicap

Zoek gegevens in het handicapdossier van een persoon.

Workflow expressie

${magda.giveDossierHandicap(String ssin, String date, String uri, String dossierId)}

Input

Inputparameters	Data type	Voorbeeld	Uitleg
insz	String	‘85010212345’	Identificatienummer voor de sociale zekerheid (rijksregisternummer)
date	String	‘2020-01-01'	Referentedatum
uri	String	-	Aansluiting bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda)
dossierId	String (GUID)	-	Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call)

Output

Je krijgt een object GeefDossierHandicapResponse terug met handicapgegevens voor een persoon.

Magda-documentatie

Technische documentatie GeefDossierHandicap-03.00.

giveDossierHandicapByPeriod

Zoek gegevens in het handicapdossier van een persoon (voor een specifieke periode).

Workflow expressie

${magda.giveDossierHandicapByPeriod(String ssin, String beginDate, String endDate, String uri, String hoedanigheid, String dossierId)}

Input

Inputparameters	Data type	Voorbeeld	Uitleg
insz	String	‘85010212345’	Identificatienummer voor de sociale zekerheid (rijksregisternummer)
beginDate	String	‘2020-01-01'	Startdatum referteperiode
endDate	String	‘2025-01-01'	Einddatum referteperiode
uri	String	-	Aansluiting bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda)
hoedanigheid	String	-	IDPC-code, uniek aansluitingsnummer bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda)
dossierId	String (GUID)	-	Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call)

Output

Je krijgt een object GeefDossierHandicapResponse terug met handicapgegevens voor een persoon binnen een opgegeven referteperiode.

Magda-documentatie

Technische documentatie GeefDossierHandicap-03.00.

giveDossierHandicapWithHc

Zoek gegevens in het handicapdossier van een persoon en filter op handicapcode of categorie.

Workflow expressie

${magda.giveDossierHandicapWithHc(String ssin, String date, String uri, String hc, String dossierId)}

Input

Inputparameters	Data type	Voorbeeld	Uitleg
insz	String	‘85010212345’	Identificatienummer voor de sociale zekerheid (rijksregisternummer)
date	String	‘2020-01-01'	Refertedatum
uri	String	-	Aansluiting bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda)
hc	String	-	IDPC-code, uniek aansluitingsnummer bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda)
dossierId	String (GUID)	-	Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call)

Output

Je krijgt een object GeefDossierHandicapResponse terug met handicapgegevens voor een persoon voor de opgegeven refertedatum en rekening houdend met de gekozen filter.

Magda-documentatie

Technische documentatie GeefDossierHandicap-03.00.

giveHandicap

Vraag de handicapstatus op voor een bepaalde persoon.

Workflow expressie 1

Variant waarbij je terugvalt op de default magda aansluitingsgegevens.

${magda.giveHandicap(String insz, String date, String begin, String end, String dossierId)}

Input

Inputparameters	Data type	Voorbeeld	Uitleg
insz	String	‘85010212345’	Identificatienummer voor de sociale zekerheid (rijksregisternummer)
date	String	‘2020-01-01'	Refertedatum
begin	String	‘2011-01-01'	Startdatum referteperiode
end	String	‘2025-01-05’	Einddatum referteperiode
dossierId	String (GUID)	-	Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call)

Workflow expressie 2

Variant waarbij de magda aansluitingsgegevens expliciet worden meegegeven.

${magda.giveHandicap(String insz, String date, String begin, String end, String uri, String hoedanigheid, String dossierId)}

Input

Inputparameters	Data type	Voorbeeld	Uitleg
insz	String	‘85010212345’	Identificatienummer voor de sociale zekerheid (rijksregisternummer)
date	String	‘2020-01-01'	Refertedatum
begin	String	‘2011-01-01'	Startdatum referteperiode
end	String	‘2025-01-05’	Einddatum referteperiode
uri	String	-	Aansluiting bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda)
hoedanigheid	String	-	IDPC-code, uniek aansluitingsnummer bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda)
dossierId	String (GUID)	-	Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call)

Output

Je krijgt een object GeefHandicapResponse terug met de handicapstatus voor de opgegeven persoon.

Magda-documentatie

Technische documentatie GeefHandicap.

giveLeefloonbedragen

Vraag uitgekeerde leefloonbedragen op voor de gegeven persoon.

Workflow expressie 1

Variant waarbij je terugvalt op de default magda aansluitingsgegevens.

${magda.giveLeefloonbedragen(String insz, String year, String numberOfYearsBack, String dossierId)}

Input

Inputparameters	Data type	Voorbeeld	Uitleg
insz	String	‘85010212345’	Identificatienummer voor de sociale zekerheid (rijksregisternummer)
year	String	‘2020'	Refertejaar
numberOfYearsBack	String	‘2'	Referteperiode (aantal jaren voorafgaand aan het refertejaar)
dossierId	String (GUID)	-	Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call)

Workflow expressie 2

Variant waarbij de magda aansluitingsgegevens expliciet worden meegegeven.

${magda.giveLeefloonbedragen(String insz, String year, String numberOfYearsBack, String uri, String hoedanigheid, String dossierId)}

Input

Inputparameters	Data type	Voorbeeld	Uitleg
insz	String	‘85010212345’	Identificatienummer voor de sociale zekerheid (rijksregisternummer)
year	String	‘2020'	Refertejaar
numberOfYearsBack	String	‘2'	Bepaalt de referteperiode (aantal jaren voorafgaand aan het refertejaar)
uri	String	-	Aansluiting bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda)
hoedanigheid	String	-	IDPC-code, uniek aansluitingsnummer bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda)
dossierId	String (GUID)	-	Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call)

Output

Je krijgt een object GeefLeefloonbedragenResponse met uitgekeerde leefloonbedragen voor de opgegeven persoon.

Magda-documentatie

Technische documentatie GeefLeefLoonBedragen-02.00.

giveLivingWagePeriods

Vraag uitgekeerde leefloonbedragen op voor de gegeven persoon en voor een specifieke periode.

Variant waarbij je terugvalt op de default magda aansluitingsgegevens.

Workflow expressie

${magda.giveLivingWagePeriods(String ssin, String startDate, String endDate, String dossierId)}

Input

Inputparameters	Data type	Voorbeeld	Uitleg
ssin	String	‘85010212345’	Rijksregisternummer
startDate	String	‘2020-01-01’	Startdatum voor de referteperiode
endDate	String	‘2025-07-31'	Einddatum voor de referteperiode
dossierId	String (GUID)	-	Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call)

Output

Je krijgt een object GeefLeefloonperiodesResponse met leefloonbedragen uitgekeerd aan een persoon voor een bepaalde periode.

Magda-documentatie

Technische documentatie GeefLeefLoonPeriodes-02.00.

giveLivingWagePeriodsWithUri

Vraag uitgekeerde leefloonbedragen op voor de gegeven persoon en voor een specifieke periode.

Variant waarbij de magda aansluitingsgegevens expliciet worden meegegeven.

Workflow expressie

${magda.giveLivingWagePeriodsWithUri(String ssin, String startDate, String endDate, String uri, String hoedanigheid, String dossierId)}

Input

Inputparameters	Data type	Voorbeeld	Uitleg
ssin	String	‘85010212345’	Rijksregisternummer
startDate	String	‘2020-01-01’	Startdatum voor de referteperiode
endDate	String	‘2025-07-31'	Einddatum voor de referteperiode
uri	String	-	Aansluiting bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda)
hoedanigheid	String	-	IDPC-code, uniek aansluitingsnummer bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda)
dossierId	String (GUID)	-	Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call)

Output

Je krijgt een object GeefLeefloonperiodesResponse met leefloonbedragen uitgekeerd aan een persoon voor een bepaalde periode.

Magda-documentatie

Technische documentatie GeefLeefLoonPeriodes-02.00.

giveReplacementIncome

Vraag gegevens vervangingsinkomen.

Workflow expressie

${magda.giveReplacementIncome(String insz, String uri, String begin, String end, String dossierId)}

Input

Inputparameters	Data type	Voorbeeld	Uitleg
ssin	String	‘85010212345’	Rijksregisternummer
uri	String	-	Aansluiting bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda)
startDate	String	‘2020-01-01’	Startdatum voor de referteperiode
endDate	String	‘2025-07-31'	Einddatum voor de referteperiode
dossierId	String (GUID)		Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call)

Output

Je krijgt een object GeefVervangingsinkomenUitWerkloosheidResponse met gegevens over vervangingsinkomen voor een persoon.

Magda-documententatie

Technische documentatie GeefVervangingsInkomenUitWerkloosheid-02.01.

giveSociaalStatuut

Check of een persoon voldoet aan bepaalde sociale statuten.

Workflow expressie 1

${magda.giveSociaalStatuut(String ssin, Map<String, String> socialeStatuten, String uri, String hoedanigheid, String dossierId)}

Input

Inputparameters	Data type	Voorbeeld	Uitleg
ssin	String	‘85010212345’	Rijksregisternummer
socialeStatuten	Map<String,String>	-	Filter op specifieke sociale statuten
uri	String	-	Aansluiting bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda)
hoedanigheid	String	-	IDPC-code, uniek aansluitingsnummer bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda)
dossierId	String (GUID)	-	Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call)

Workflow expressie 2

${magda.giveSociaalStatuut(String ssin, Map<String, String> socialeStatuten, String locatie, String uri, String hoedanigheid, String dossierId)}

Input

Inputparameters	Data type	Voorbeeld	Uitleg
ssin	String	‘85010212345’	Rijksregisternummer
socialeStatuten	Map<String,String>	-	Filter op specifieke sociale statuten
locatie	String	‘REGIO_GENT’	Bijkomende filter voor locatie
uri	String	-	Aansluiting bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda)
hoedanigheid	String	-	IDPC-code, uniek aansluitingsnummer bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda)
dossierId	String (GUID)	-	Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call)

Output

Je krijgt een object GeefSociaalStatuutResponse met info of de persoon al dan niet voldoet aan het sociaal statuut.

Magda-documentatie

Technische documentatie GeefSociaalStatuut-03.00.

giveSociaalStatuutWithPeriod

Check of een persoon voldoet aan een bepaald sociale statuut binnen de opgegeven periode.

Workflow expressie

${magda.giveSociaalStatuutWithPeriod(String ssin, String sociaalStatuut, String beginDatum, String eindDatum, String uri, String hoedanigheid, String dossierId)}

Input

Inputparameters	Data type	Voorbeeld	Uitleg
ssin	String	‘85010212345’	Rijksregisternummer
sociaalStatuut	String	-	Filter op specifiek sociaal statuut
beginDatum	String	‘2025-01-01’	Startdatum voor de referteperiode
eindDatum	String	‘2025-07-30'	Einddatum voor de referteperiode
uri	String	-	Aansluiting bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda)
hoedanigheid	String	-	IDPC-code, uniek aansluitingsnummer bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda)
dossierId	String (GUID)	-	Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call)

Output

Je krijgt een object GeefSociaalStatuutResponse met info of de persoon al dan niet voldoet aan het sociaal statuut binnen de opgegeven referteperiode.

Magda-documentatie

Technische documentatie GeefSociaalStatuut-03.00.