0808API-integratie
Een dossier openen vanuit uw eigen software.
Als uw medewerkers een cliënt in uw vakprogramma invoeren en hem hier opnieuw intikken, gaat die tweede invoer op termijn afwijken. De API bestaat zodat het dossier vertrekt van waar de cliënt al gekend is.
Deze pagina zegt hoe een integratie eruitziet en wat ze vraagt. De volledige technische referentie, met de verzoeken, de antwoorden en de code om handtekeningen na te gaan, staat op de pagina voor ontwikkelaars.
01Authenticatie
OAuth2, scope per scope.
De toegang verloopt via OAuth2-clientgegevens. Tokens gelden een uur: houd ze in cache en vernieuw ze bij het verstrijken in plaats van bij elke oproep.
Gedeclareerde scopes
- onboardings:read
- onboardings:write
- clients:read
- clients:write
- companies:read
- register:read
- register:write
- reports:read
- verifications:read
- verifications:write
- webhooks:manage
Vraag de smalste set die uw werk doet. De eindpunten voor dossiers en voor het register bestaan vandaag: reports:read en webhooks:manage zijn gedeclareerd voor eindpunten die nog niet gebouwd zijn en verlenen niets.
02Het gangbare traject
Drie oproepen en een levend dossier.
De gangbaarste integratie probeert de toepassing niet over te doen. Ze maakt het dossier met wat uw software al weet, laat de naleving hier gebeuren en blijft op de hoogte van het vervolg.
- GET
/api/v2/register/companies/{n}Het register raadplegen
Nog voor u iets opent: identiteit, adres, activiteiten, financiële score, neergelegde jaarrekeningen en publicaties in het Staatsblad. Een onderneming die u nooit hebt onboarded antwoordt ook, want het register is openbaar.
Geeft terug de openbare fiche, en wat uw organisatie er al over weet - POST
/api/v2/onboardingsHet dossier aanmaken
Een ondernemingsnummer volstaat: de fiche vult zich vooraf in vanuit het officiële register, zodat u geen wettelijke gegevens verstuurt die u niet beheerst.
Geeft terug de identificatie van het aangemaakte dossier - POST
/api/v2/onboardings/{id}/beneficiariesHet aanvullen
Voeg toe wat uw software heeft en het register niet geeft: contactpersonen, aard van de opdracht, reeds verzamelde stukken.
Geeft terug de aan het dossier toegevoegde begunstigde - POST
/api/v2/onboardings/{id}/submitDe beslissing volgen
In plaats van de API in een lus te bevragen, laat u de webhook u verwittigen wanneer het dossier van toestand verandert.
Geeft terug het dossier bij de AMLCO, het vervolg komt via webhook
03Webhooks
Ondertekend, en na te gaan.
Elke zending draagt een handtekening berekend met uw gedeeld geheim. Een ontvangst zonder controle zou elk verzoek aanvaarden dat beweert van ons te komen, precies het risico waarvoor de handtekening bestaat.
POST https://votre-app.example.com/hooks/aml
x-amlcompany-signature: v1=9f86d0818…
04Zandbak
Probeer het zonder echte dossiers te maken.
Een testomgeving laat u het volledige traject doorlopen met daarvoor bestemde gegevens, voor u de integratie op uw echte organisatie aansluit.
Voorbehouden ondernemingsnummers
| Nummer | Wat er gebeurt |
|---|---|
| BE0999999001 | Een volledige vennootschap, SANDBOX TEST SRL |
| BE0999999002 | Een vennootschap gebouwd om als hoger risico te scoren |
| BE0999999404 | Altijd onvindbaar: het pad dat u nooit opnieuw mag proberen |
| BE0999999500 | Altijd mislukt: het pad dat u wel opnieuw moet proberen |
Een zandbak bevraagt nooit het officiële register: uw tests zouden afhangen van een derde en van gegevens die onder hen bewegen. De laatste twee nummers zijn het voornaamste nut, want het echte register laat zich niet op verzoek falen.
De inloggegevens van de zandbak, de test-ondernemingsnummers en de reproduceerbare foutcodes staan in de ontwikkelaarsreferentie.