PUT CHECKRISK GDA/PPE

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

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

Exemple de réponse obtenue si la personne a matché avec des correspondances pendant le filtrage, ce qui a conduit a 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"
      }
    }
  ]
}

Remarque : si plusieurs dossiers de risque sont créés à la suite du contrôle, plusieurs éléments seront présents dans le champ "risks". Chaque dossier aura un type différent.