GET LISTRISKS GDA/PPE | BeCLM - Documentation APIs

Ce endpoint de l'API permet de récupérer la liste paginée des dossiers de risque d’une société. Un tri par date de dernière modification peut être effectué.

Description

La description complète est accessible sur notre swagger

Méthode

GET

Paramètres

Param	Type	Description	Exemple
`from`	Integer	Gestion de la pagination : Index du premier résultat à renvoyer - inclusif Non obligatoire. Par défaut : 0	0
`to`	Integer	Gestion de la pagination : Index du dernier résultat à renvoyer - exclusif Non obligatoire. Par défaut : 25	30
`fromDate`	datetime - iso8601 format	La date et heure minimale de dernière modification du dossier de risque Non obligatoire. Par défaut : date de création de la société	2022-12-01T12:00:00.000Z
`toDate`	datetime - iso8601 format	La date et heure maximale de dernière modification du dossier de risque Non obligatoire. Par défaut : date de l’appel API	2023-12-01T12:00:00.000Z
`type`	String	Le type de dossier de risque à lister. Non obligatoire. Par défaut : BLACKLIST (Gel Des Avoirs) et PEP (Personne Politiquement Exposée)	BLACKLIST

Réponse

Extrait de réponse obtenue pour une société où 247 dossiers de risque GDA et PPE existent :

{
  "availableCount": 247,
  "from": 0,
  "to": 25,
  "results": [
    {
      "_id": "64cb7d4bd5eb9669c1807a8c",
      "lastEditBy": "admin",
      "lastEditionDate": "2023-11-30T14:02:09.588Z",
      "type": "BLACKLIST",
      "maxMatchingScore": 100,
      "person": {
        "_id": "64cb7d4bd5eb9669c1807a8a",
        "externalRef": "SOURCE/REFERENCE_01",
        "identity": {
          "lastName": "UNIVERSITY",
          "birth": {}
        },
        "postalAddress": {},
        "personType": "PROSPECT",
        "legalForm": "SARL"
      }
    },
    {
      "_id": "652fd2ce36227d08bc369b3d",
      "lastEditBy": "admin",
      "lastEditionDate": "2023-11-30T14:02:09.632Z",
      "type": "PEP",
      "maxMatchingScore": 100,
      "person": {
        "_id": "652fd2cb36227d08bc369b3b",
        "externalRef": "SOURCE/REFERENCE_02",
        "identity": {
          "firstName": "Christine",
          "lastName": "ANDERSON",
          "birth": {}
        },
        "postalAddress": {}
      }
    },
    {
      "_id": "65452ba6deafbb53d51e7628",
      "lastEditBy": "admin",
      "lastEditionDate": "2023-11-09T08:32:09.916Z",
      "type": "BLACKLIST",
      "maxMatchingScore": 92,
      "person": {
        "_id": "652fd2cb36227d08bc369b3b",
        "externalRef": "SOURCE/REFERENCE_02",
        "identity": {
          "firstName": "Christine",
          "lastName": "ANDERSON",
          "birth": {}
        },
        "postalAddress": {}
      }
    },
    ...
    {
      "_id": "65452ba8deafbb53d51e762a",
      "lastEditBy": "admin",
      "lastEditionDate": "2023-11-09T08:32:09.939Z",
      "type": "BLACKLIST",
      "maxMatchingScore": 89,
      "person": {
        "_id": "65452b4fdeafbb53d51e752f",
        "externalRef": "SOURCE/REFERENCE_25",
        "identity": {
          "civility": "MR",
          "lastName": "ANDRE",
          "birth": {}
        },
        "postalAddress": {}
      }
    }
  ]
}