BeCLM - Documentation APIs
Breadcrumbs

PUT CHECK RISK PM KYC


Cet endpoint de l'API permet de créer ou mettre à jour les informations d'une personne morale, et de lancer le filtrage.

Une réponse synchrone est reçue suite à la création ou mise à jour de la personne morale.

Une réponse asynchrone est reçue suite à l’exécution des contrôles sur la personne, contenant les résultats de ces contrôles


Description

Les descriptions complètes de l’appel et de la réponse asynchrone sont accessibles sur notre swagger


Méthode

PUT


Paramètres d’entrée

Param

Type

Description

Exemple

sourceName

String

Nom technique de la source sur laquelle la personne morale va être créée

CLIENTS

externalRefId

String

La référence de la personne morale qui va être créée ou mise à jour

134679852

Exemple de body

{{
  "contracts": [
    {
      "type": "type",
      "number": "123456",
      "insurer": "insurer",
      "startDate": "2024-10-23",
      "endDate": "2025-10-23"
    }
  ],
  "personAdditionalInformation": {
    "personType": "personType",
    "genderCode": "genderCode",
    "birthYear": "birthYear",
    "birthMonth": "birthMonth",
    "birthPlace": "birthPlace",
    "legalForm": "legalForm",
    "iban": "truncatedIban"
  },
  "personMetaData": {
    "entities": [
      "entity"
    ],
    "subEntities": [
      "subEntity"
    ]
  },
  "personCustomFields": [
    {
      "personCustomFieldDescriptorId": "personCustomFieldDescriptorId",
      "value": "1500.58"
    }
  ],
  "sirenCode": "123456789",
  "name": "Example Legal Entity",
  "creationDate": "2019-10-23",
  "oriasId": "12345678",
  "naf": "B06_10Z",
  "postalAddress": {
    "address": "1 rue du test",
    "zipCode": "40500",
    "city": "COUDURES",
    "country": "FRA",
    "building": "Appartement 01"
  },
  "registrationDate": "2020-11-24",
  "issuingOffice": "issuingOffice",
  "contract": {
    "startDate": "2025-03-01T10:00:00Z",
    "endDate": "2026-03-01T10:00:00Z",
    "legalEntityRef": {
      "sourceName": "sourceName",
      "externalRefId": "externalRefId"
    }
  },
  "siret": "12345678901234",
  "legalCategory": "legalCategory",
  "personType": "personType",
  "headcount": 11,
  "headcountRange": "R010_049",
  "legalEntityExtraData": {
    "occupation": "occupation"
  }
}

}

 

Réponse synchrone

Sortie immédiate : 

Exemple de réponse obtenue quand la personne morale a été créée/mise à jour :

{
  "contracts": [
    {
      "type": "type",
      "number": "123456",
      "insurer": "insurer",
      "startDate": "2024-10-23",
      "endDate": "2025-10-23"
    }
  ],
  "personAdditionalInformation": {
    "personType": "personType",
    "genderCode": "genderCode",
    "birthYear": "birthYear",
    "birthMonth": "birthMonth",
    "birthPlace": "birthPlace",
    "legalForm": "legalForm",
    "iban": "truncatedIban"
  },
  "personMetaData": {
    "entities": [
      "entity"
    ],
    "subEntities": [
      "subEntity"
    ]
  },
  "personCustomFields": [
    {
      "personCustomFieldDescriptorId": "67b5ffc62d446968eeb0faa4",
      "value": "FRA"
    }
  ],
  "sirenCode": "325050383",
  "name": "Example Legal Entity",
  "creationDate": "2019-10-23",
  "oriasId": "12345678",
  "naf": "B06_10Z",
  "postalAddress": {
    "address": "1 rue du test",
    "zipCode": "40500",
    "city": "COUDURES",
    "country": "FRA",
    "building": "Appartement 01"
  },
  "registrationDate": "2020-11-24",
  "issuingOffice": "issuingOffice",
  "contract": {
    "startDate": "2025-03-01T10:00:00Z",
    "endDate": "2026-03-01T10:00:00Z"
  },
  "siret": "12345678942420",
  "legalCategory": "legalCategory",
  "personType": "personType",
  "headcount": 11,
  "headcountRange": "R010_049",
  "legalEntityExtraData": {
    "occupation": "occupation"
  }
}

 

Réponse asynchrone

Exemple de réponse asynchrone obtenue :

{
  "eventId": "ad2c10df-d861-4634-baf7-eb314a56e92c",
  "data": {
    "externalRef": {
      "sourceName": "sourceName",
      "externalRefId": "externalRefId"
    },
    "controlsData": {
      "riskStatus": "POTENTIAL_RISK",
      "lastControlDate": "2025-03-05T10:00:00Z",
      "controlResults": [
        {
          "controlFamilyId": "66fa8d123bce49b2393135e5",
          "controlFamilyName": "Risques LCB-FT",
          "controlTypeId": 3,
          "controlTypeName": "GafiControl",
          "date": "2025-03-05T10:00:00Z",
          "computed": true,
          "score": 100,
          "status": "POTENTIAL_RISK",
          "description": "Contrôle GAFI",
          "controlData": "Donnée Client",
          "type": "THRESHOLD"
        },
        {
          "controlFamilyId": "66fa8d123bce49b2393135e5",
          "controlFamilyName": "Risques LCB-FT",
          "controlTypeId": 0,
          "controlTypeName": "BlacklistControl",
          "date": "2025-03-05T09:50:00Z",
          "computed": true,
          "score": 100,
          "status": "POTENTIAL_RISK",
          "description": "Contrôle GDA",
          "controlData": "Donnée Client",
          "riskFolderId": "88fa8d123bce49b2393139f0",
          "type": "BLACKLIST_PEP"
        },
        {
          "controlFamilyId": "66fa8d123bce49b2393135e5",
          "controlFamilyName": "Risques LCB-FT",
          "controlTypeId": 0,
          "controlTypeName": "OriasControl",
          "date": "2025-03-05T09:50:00Z",
          "computed": true,
          "score": 100,
          "status": "POTENTIAL_RISK",
          "description": "Contrôle Orias",
          "controlData": "Données Client",
          "oriasRegistration": {
            "number": "12345678",
            "status": "UNREGISTERED",
            "dateChecked": "2025-03-05T09:50:00Z"
          },
          "type": "ORIAS"
        },
        {
          "controlFamilyId": "66fa8d123bce49b2393135e5",
          "controlFamilyName": "Risques Bodacc",
          "controlTypeId": 0,
          "controlTypeName": "CreationBodaccEventControl",
          "date": "2025-03-05T09:50:00Z",
          "computed": true,
          "score": 100,
          "status": "POTENTIAL_RISK",
          "description": "Contrôle Bodacc",
          "controlData": "Données Client",
          "nbOfPastYearEvents": 1,
          "type": "BODACC_EVENT"
        },
        {
          "controlFamilyId": "66fa8d123bce49b2393135e5",
          "controlFamilyName": "Risques LCB-FT",
          "controlTypeId": 53,
          "controlTypeName": "BlacklistLinkedPersonControl",
          "date": "2025-03-05T09:50:00Z",
          "computed": true,
          "score": 80,
          "status": "POTENTIAL_RISK",
          "description": "Résultats de contrôle GDA pour les personnes liées",
          "controlData": "LinkedPersonExternalRefId - 80% - Risque potentiel ",
          "personLinkBlacklistPepAmControlResultSummaries": [
            {
              "externalRefId": "LinkedPersonExternalRefId",
              "score": 80,
              "status": "POTENTIAL_RISK"
            }
          ],
          "type": "LINKED_PERSON"
        },
        {
          "controlFamilyId": "66fa8d123bce49b2393135e5",
          "controlFamilyName": "Risques LCB-FT",
          "controlTypeId": 71,
          "controlTypeName": "VigilanceLinkedPersonControl",
          "date": "2025-03-05T09:50:00Z",
          "computed": true,
          "score": 75,
          "status": "POTENTIAL_RISK",
          "description": "Résultats de contrôle de vigilance pour les personnes liées",
          "controlData": "LinkedPersonExternalRefId - Vigilance élevée - Vigilance Test ",
          "controlResultSummaries": [
            {
              "externalRefId": "LinkedPersonExternalRefId",
              "score": 75,
              "status": "POTENTIAL_RISK",
              "vigilanceCombinationName": "Vigilance TEST"
            }
          ],
          "type": "LINKED_PERSON"
        },
        {
          "controlFamilyId": "66fa8d123bce49b2393135e5",
          "controlFamilyName": "Risques LCB-FT",
          "controlTypeId": 56,
          "controlTypeName": "VigilanceControl",
          "date": "2025-03-05T09:50:00Z",
          "computed": true,
          "score": 75,
          "status": "POTENTIAL_RISK",
          "description": "Données et résultats de contrôle de la personne",
          "vigilanceCombinationName": "Vigilance allégée",
          "vigilanceStatus": "HIGH_VIGILANCE_STATUS",
          "type": "VIGILANCE"
        }
      ],
      "pcrId": "2025-03-05T10:00:00.000Z-KYC-cb3b5b33-6929-4caf-b27e-60fdbaa7cdef"
    }
  },
  "type": "ASYNC_RESPONSE"
}