PUT RISK EVALUATION KYC | BeCLM - Documentation APIs

Ces endpoints de l'API permettent de qualifier un ou plusieurs contrôles sur une personne.

Description

Les descriptions complètes de l’appel et de la réponse synchrone sont accessibles sur notre swagger. Il existe deux endpoints qui fonctionnent de la même façon : un pour les personnes physiques et un pour les personnes morales.

Pour chaque contrôle que l’on souhaite qualifier, indiquer :

controlTypeId : l’id du contrôle (obligatoire)
initialStatus : le statut en l'état, avant qualification par API (obligatoire)
- Statuts possibles :
  - POTENTIAL_RISK
  - MATCH
  - NO_MATCH
  - UNKNOWN
finalStatus : le statut de qualification souhaité (obligatoire)
- Statuts possibles :
  - MATCH
  - NO_MATCH
  - UNKNOWN
comment : commentaire à saisir au niveau de l’indicateur (facultatif)

Cas particuliers

Les contrôles GDA, PPE et AM ne sont pas qualifiables par cet appel API
Le statut de vigilance et le contrôle des personnes liées ne sont pas qualifiables. Ils seront ignorés s’ils sont mis dans l’appel.
On ne peut pas qualifier un contrôle sur une personne radiée

Méthode

PUT

Paramètres d’entrée

Param	Type	Description	Exemple
`sourceName`	String	Nom technique de la source sur laquelle se trouve la personne	CLIENTS
`externalRefId`	String	La référence de la personne sur laquelle on souhaite qualifier des risques	134679852

Exemple de body

"controlQualifications": [
    {
      "controlTypeId": "01",
      "initialStatus": "POTENTIAL_RISK",
      "finalStatus": "NO_MATCH",
      "comment": "comment1"
    },
    {
      "controlTypeId": "02",
      "initialStatus": "UNKNOWN"
      "finalStatus": "MATCH",
      "comment": ""
    }

A l’exécution de cet appel :

Chaque contrôle présent dans le bloc est qualifié au statut renseigné
L’historique des statuts est mis à jour en conséquence
Si saisi, un commentaire est ajouté avec
- date et heure
- utilisateur API ayant effectué l’appel
- contenu du commentaire saisi

Réponse synchrone

On renvoie la liste des contrôles qui ont bien été qualifiés, avec leur statut final

Pour chaque contrôle qualifié on inclut

controlTypeId : l’ID du contrôle
currentStatus : le statut final du contrôle après qualification
addedComment : le dernier commentaire sur le contrôle