Version de l’API Rest de Seyna AML Rappel des concepts manipulés Se connecter à l’API RestRécupérer un Token d’identification Créer un dossier surveilléConsulter un dossier surveillé Consulter une alerte Consulter une entité des listes de sanctionClôturer une alerte
Seyna AML propose deux API :
- Rest API
- GraphQL
Version de l’API Rest de Seyna AML
La version la plus récente est la version 2024-02
Vous pouvez consulter la documentation complète avec ce lien :
Seyna API - Documentation
seyna documentation api
https://developers.seyna.eu/2024-02
Rappel des concepts manipulés
Seyna AML s'appuie sur les notions suivantes:
- Dossier surveillé (Record)
- D'alerte (alert) à gérer sur un dossier
- Une alerte peut avoir avec une ou plusieurs correspondances (match)
- Des listes de sanctions (dataset) composées d'entités (entity) de type Personne ou Entreprise
Voici les étapes à suivre pour commencer à suivre des dossiers.
Se connecter à l’API Rest
Seyna AML propose une API Rest, disponible sur l’URL suivante :
Pour utiliser l'API, vous avez besoin d'un client Rest API et d'un token. Il faut également :
- Un ID de produit
- Avoir activé Seyna AML
Récupérer un Token d’identification
Pour récupérer un token, il faut se rendre sur la page de “paramètre” et cliquer sur Clés API.
Il faut ensuite ajouter une clé en cliquant sur Ajouter une clé
Puis récupérer son token en cliquant sur voir le token
Notez ce token, il sera utilisé pour authentifier les requêtes exécutées via le client graphQL et également pour les appels API Rest.
Récupérer l’identifiant du produit
Pour commencer à créer des dossiers surveillés, il est nécessaire d’avoir l’identifiant du produit (Product ID).
Pour cela vous devez aller sur l’interface, dans “Paramètres” puis “Configuration des produits d’assurance”
Vous trouverez la liste de vos produits.
En cliquant sur le produit concerné par Seyna AML, vous obtiendrez les informations relatives au produit dont l’identifiant du produit (Product ID).
Créer un dossier surveillé
La fonctionnalité principale de l’API consiste à créer un dossier à surveiller.
Un dossier surveillé demande en entrée :
- un nom
- une identification (Dossier Entreprise) ou une date de naissance (Dossier Personne)
- une référence externe (facultatif)
- un lien externe (facultatif)
- Période définie de surveillance / vérification instantanée
- une date de fin (facultatif)
Le traitement dans la réponse est différente entre :
- un dossier surveillé instantanément : la vérification est synchrone.
- un dossier avec une date de fin : la vérification se fait de manière asynchrone et peut prendre de 3 à 10 secondes. Nous faisons cela pour des raisons de performance.
- PENDING_INITIAL_CHECK: The record is being reviewed if it has or not any alerts
- NEW_ALERT: There is a new alert associated with the Record
- OK_NO_ALERTS: There are no alerts for the Record
- OK_ALL_ALERTS_RESOLVED: All the alerts of the Records are being resolved
Consulter un dossier surveillé
Cette fonctionnalité est essentielle pour obtenir des informations sur un dossier surveillé créé. Grâce à cette requête, vous pouvez accéder à des données du dossiers et visualiser le statut de l’alerte.
Consulter une alerte
Vous pouvez aller récupérer la liste des alertes également.
L’API permet également d’accéder en lecture aux différents objets qui constituent Seyna AML.
Dans l’alerte, vous avez accès à plusieurs objets :
- le statut de l’alerte
- les matchs qui sont les correspondances dans lesquelles vous avez les entités des listes de sanctions
- la timeline qui comporte les emails et les commentaires
Il est possible de consulter les alertes d’un produit ou les alertes d’un dossier surveillé.
Les statuts des alertes sont :
- "CREATED"
- "IN_PROGRESS"
- "RESOLVED”
Consulter une entité des listes de sanction
Afin de pouvoir établir les vérifications, vous pouvez consulter les entités des listes de sanction.
Clôturer une alerte
Après avoir effectuer les démarches pour obtenir des informations complémentaires suite à un match et obtenu une preuve de la vérification d’un faux positif, vous pouvez clore une alerte.