PUT CHECKRISK GDA/PPE/AM | BeCLM

Ce endpoint de l'API permet d'ajouter ou mettre à jour les informations d'une personne et effectuer le filtrage sur cette personne. Le filtrage peut donner lieu à la création ou la mise à jour de dossiers de risques associés.

Description

La description complète est accessible sur notre swagger

Méthode

PUT

Paramètres

Param	Type	Description	Exemple
`externalRefId`	String	La référence de la personne pour laquelle on envoie les informations mises à jour.	5a145d6765cc642c9a076f68
`flowName`	String	Nom du flux utilisé pour le contrôle, la personne sera importée dans la source associée au flux	F1

Body

Le body contient les données d’une personne.

La référence externe et le nom (ou raison sociale) sont obligatoires.

Donnée	Type	Description	Obligatoire
`externalRef`	string	Référence externe de la personne	O
`identity > civility`	Enum <“MR”, “MRS”, “SOC”>	Civilité de la personne	N
`identity > firstName`	string	Prénom de la personne	N
`identity > lastName`	string	Raison sociale ou Nom de famille (ou d’usage) de la personne	O
`identity > maidenName`	string	Nom de naissance (ou de jeune fille) de la personne	N
`identity > nationality`	string	Nationalité de la personne	N
`identity > birth > date`	string (AAAA-MM-JJ)	Date de naissance de la personne	N
`identity > birth > place`	string	Lieu de naissance de la personne	N
`identity > birth > department`	string	Département de naissance de la personne	N
`identity > birth > country`	string	Pays de naissance de la personne	N
`postalAddress > address`	string	Numéro et voie de l’adresse de la personne	N
`postalAddress > zipCode`	string	Code postal de l’adresse de la personne	N
`postalAddress > city`	string	Commune de l’adresse de la personne	N
`postalAddress > country`	string	Pays de l’adresse de la personne	N
`personType`	string	Type de personne	N
`legalForm`	string	Forme juridique de la personne	N

Exemple de body

JSON

{
  "externalRef": "yourUniqueId",
  "identity": {
    "civility": "MR",
    "firstName": "BIN",
    "lastName": "LADEN",
    "maidenName": "maidenName",
    "nationality": "French",
    "birth": {
      "date": "1980-10-25",
      "place": "Bordeaux",
      "department": "Department",
      "country": "France"
    },
    "nameMetaphoneCodes": {
      "primary": "LTN"
    }
  },
  "postalAddress": {
    "address": "1 rue du test",
    "zipCode": "33700",
    "city": "Mérignac",
    "country": "France"
  },
  "personType": "personType",
  "legalForm": "legalForm"
}

Réponse

Le réponse contient les données de la personne qui vient d'être créée ou mise à jour et les résultats des contrôles GDA, PPE et Adverse Media.

Donnée	Type	Description	Remarque
`_id`	string	Identifiant unique de la personne dans le système
`externalRef`	string	Référence externe de la personne
`identity > civility`	Enum <“MR”, “MRS”, “SOC”>	Civilité de la personne
`identity > firstName`	string	Prénom de la personne
`identity > lastName`	string	Raison sociale ou Nom de famille (ou d’usage) de la personne
`identity > maidenName`	string	Nom de naissance (ou de jeune fille) de la personne
`identity > nationality`	string	Nationalité de la personne
`identity > birth > date`	string (AAAA-MM-JJ)	Date de naissance de la personne
`identity > birth > place`	string	Lieu de naissance de la personne
`identity > birth > department`	string	Département de naissance de la personne
`identity > birth > country`	string	Pays de naissance de la personne
`nameMetaphoneCodes`		Liste des prononciations du nom
`nameMetaphoneCodes > primary`	string	Phonème anglophone du nom
`nameMetaphoneCodes > secondary`	string	Phonème non-anglophone du nom	N’est présent que s’il différent du phonème anglophone
`postalAddress > address`	string	Numéro et voie de l’adresse de la personne
`postalAddress > zipCode`	string	Code postal de l’adresse de la personne
`postalAddress > city`	string	Commune de l’adresse de la personne
`postalAddress > country`	string	Pays de l’adresse de la personne
`personType`	string	Type de personne
`legalForm`	string	Forme juridique de la personne
`risks`		Liste des dossiers GDA, PPE et AM de la personne	Si la personne n’a aucun dossier de risque, la liste est vide. Sinon, la liste contient un élément par dossier de risque (GDA, PPE ou Adverse Media).
`risks > _id`	string	Identifiant unique du dossier de risque dans le système
`risks > lastEditBy`	string	Email de l’utilisateur qui a édité le dossier en dernier
`risks > lastEditionDate`	string (AAAA-MM-JJThh:mm:ss.sssZ)	Date et heure de la dernière édition du dossier
`risks > type`	Enum <“BLACKLIST”, “PEP”, “ADVERSE_MEDIA”>	Type du dossier de risque	“BLACKLIST” = GDA “PEP” = PPE “ADVERSE_MEDIA” = Média Négatif
`risks > maxMatchingScore`	int	Maximum des scores de toutes les correspondances du dossier
`risks > status > authorLogin`	string	Email de la personne qui a déclenché le dernier recalcul du dossier
`risks > status > date`	string (AAAA-MM-JJThh:mm:ss.sssZ)	Date du dernier recalcul du dossier
`risks > status > state`	Enum <“POTENTIAL_RISK”, “MATCH”, “NO_MATCH”, “UNKNOWN”, “NO_RISK_FOUND”, “STRUCK_OFF”>	Statut du dossier	“POTENTIAL_RISK” = Risque Potentiel “MATCH” = Concordant “NO_MATCH” = Non concordant “UNKNOWN” = Ne sait pas “NO_RISK_FOUND” = Aucun risque détecté “STRUCK_OFF” = Radié

Exemple de réponse

Exemple de réponse obtenue si la personne a matché avec des correspondances pendant le filtrage, ce qui a conduit a la création d’un dossier de risque GDA.

JSON

{
  "_id": "62892d83e4098caee87d3eeb",
  "externalRef": "yourUniqueId",
  "identity": {
    "civility": "MR",
    "firstName": "BIN",
    "lastName": "LADEN",
    "maidenName": "maidenName",
    "nationality": "French",
    "birth": {
      "date": "1980-10-25",
      "place": "Bordeaux",
      "department": "Department",
      "country": "France"
    },
    "nameMetaphoneCodes": {
      "primary": "LTN"
    }
  },
  "postalAddress": {
    "address": "1 rue du test",
    "zipCode": "33700",
    "city": "Mérignac",
    "country": "France"
  },
  "personType": "personType",
  "legalForm": "legalForm",
  "risks": [
    {
      "_id": "62892db4e4098caee87d3f2a",
      "lastEditBy": "user@example.com",
      "lastEditionDate": "2023-11-24T05:33:36.549Z",
      "type": "BLACKLIST",
      "maxMatchingScore": 97,
      "status": {
        "authorLogin": "admin",
        "date": "2023-11-24T05:33:36.549Z",
        "state": "MATCH"
      }
    }
  ]
}