API Documentatie
🛠️ Technische Ondersteuning: Technische vragen kunnen gesteld worden aan onze technische ondersteuning via support@scopefintech.freshdesk.com of via onderstaand formulier.
Bij het integreren van de monitoring functionaliteit in uw eigen applicatie is het belangrijk om de juiste keuze te maken uit de 2 varianten die er zijn:
- Een push variant, waarbij mogelijke matches vanuit de CDD Api worden gepushed naar een ‘callback url’.
- Een pull variant, waarbij de afnemer zelf mogelijke matches moet uitvragen, op regelmatig basis.
Stap 1: persoon toevoegen aan monitoring lijst
Via de methode AddPerson is het mogelijk om een persoon toe te voegen aan de monitorlijst. Voor de meeste actuele lijst van parameters, zie de Swagger documentatie. Belangrijke parameters hierin zijn de volgende:
- originCallback. Geef hier de extern benaderbare endpoint op waar mogelijke monitor matches vanuit de CDD Api naar gepushed kunnen worden.
- confirmedComplianceIds Geef hier de complianceId’s op van de (eventueel) eerder uitgevoerde screening van de persoon, waarbij er al handmatig een match is aangegeven. Dit zorgt ervoor dat deze Id’s niet weer opnieuw worden teruggekoppeld als mogelijke match vanuit de monitoring.
- suppessComplianceIds Geef hier de complianceId’s op van de (eventueel) eerder uitgevoerde screening van de persoon, waarbij er handmatig is aangegeven dat de resultaten geen match zijn met de toe te voegen persoon. Dit zorgt ervoor dat deze Id’s niet weer opnieuw worden teruggekoppeld als mogelijke match vanuit de monitoring.
- referenceId Geef hier een eigen sleutel of kenmerk op. Bij een monitor notificatie wordt dit Id teruggegeven en kan gebruikt worden om eenvoudig de eigen gegevens erbij op te zoeken.
In de AddPerson response wordt een unieke sleutel teruggegeven. Deze Id wordt verderop in de processen en calls weer gebruikt, dus sla deze in de eigen applicatie op.
Stap 2a: matches verwerken via CallBackUrl (Push)
Als bij het toevoegen van een persoon via AddPerson een callbackUrl is opgegeven, wordt bij een mogelijke match een push request vanuit de CDD Api verstuurd. Er wordt een bericht volgens het schema MonitorPersonPush verstuurd naar de opgeslagen callbackUrl. De gegevens van dit request dienen in de externe applicatie te worden opgeslagen zodat een gebruiker de matches kan afhandelen.
Stap 2b: matches verwerken zonder CallBackUrl (Pull)
Als bij het toevoegen van een persoon via AddPerson geen callbackUrl is opgegeven, wordt bij een mogelijke match ook geen request vanuit de CDD Api verstuurd. De monitor matches dienen dan vanuit de externe applicatie actief en op regelmatige basis te worden opgehaald en opgeslagen zodat een gebruiker de matches kan afhandelen in zijn eigen systeem.
Als bij het actief ophalen van matches m.b.v. de methode GetPersonMatches de parameter SetProcessed=false wordt meegeleverd dan moeten de personen nog wel achteraf op op verwerkt gezet worden. Hiervoor kan de methode EditPerson gebruikt worden om één persoon te voorzien van de flag SetProcessed=true of de methode SetMatchesProcessed om alle matches in één keer als verwerkt te kenmerken.
Stap 3: handmatig opvolgen mogelijke matches
In de externe applicatie moet voor de gebruiker een scherm worden toegevoegd waarop deze de persoon met mogelijke matches kan bekijken en beoordelen.
Grafische weergave monitoring persoon SCOPE CDD API