BeCLM - Documentation APIs
Breadcrumbs

PUT CREATE CHECK PP ref et name - Création/Update et contrôle d'une personne physique à partir d'une référence et d'un nom

Ce endpoint de l'API permet de créer ou mettre à jour les informations d'une personne physique et d'effectuer des contrôles sur cette personne à partir d'une référence et d'un nom. Le filtrage peut donner lieu à la création ou la mise à jour de dossiers de risques associés.

Une réponse synchrone est reçue suite à la création de la personne morale.
Une réponse asynchrone (webhook) est reçue sur une url suite aux contrôles de la personne morale.

Description

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

 

Méthode

PUT

 

Paramètres

Param

Type

Description

Exemple

sourceName

String

Nom technique de la source sur laquelle la personne physique va être créée ou mise à jour

CLIENTS

externalRefId

String

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

REF_API_01

name

String

Nom de famille de la personne physique qui va être créée ou mise à jour

HAUCHARD

Exemple de body

{
  "sourceName": "CLIENTS",
  "identity": {
    "email": "",
    "firstName": "Maxime",
    "lastName": "HAUCHARD",
    "phoneNumber": "",
    "civility": "MR",
    "birth": {
      "date": "1990-01-31",
      "birthCity": "",
      "department": "Normandie",
      "country": "FRA",
      "nationality": "FRA"
    },
    "title": "",
    "maidenName": "",
    "nationality": "FRA",
    "socialSecurityNumber": "23452345678",
    "judicialProtectionRegime": "COURT_CUSTODY"
  },
  "postalAddress": {
    "address": "1 rue Marie Curie",
    "zipCode": "75000",
    "city": "Paris",
    "country": "France",
    "building": "Appartement 01"
  },
  "professionalInformation": {
    "professionalStatus": "profession",
    "career": "secteur d'activité",
    "sirenCode": "123456789",
    "expectedRetirementAge": "67",
    "companyAdditionalInformation": "companyName",
    "department": "companyService",
    "function": "Manager",
    "capacityLevel": "10",
    "isSupervisoryStaff": true,
    "isRemoteWorking": false,
    "shiftChangeDate": "2024-06-17T14:49:48.870Z",
    "contract": {
      "startDate": "2024-06-17T14:49:48.870Z",
      "endDate": "2024-06-17T14:49:48.870Z"
    },
    "naf": "A01_12Z",
    "socialProfessionalCategory": "L4_111A"
  },
  "externalRefId": "REF_API_01",
  "proofOfId": {
    "number": "123456789",
    "issueDate": "2012-10-18",
    "type": "CNI",
    "issuer": "Préfecture de Paris"
  },
  "insurerContracts": [
    {
      "type": "type",
      "number": "123456789",
      "insurer": "Assureur1",
      "startDate": "2022-01-31",
      "endDate": "2024-01-31"
    }
  ],
  "financialSituation": {
    "financialFlows": {
      "flowEmitterCountry": "ESP",
      "flowReceiverCountry": "FRA"
    },
    "financialAssets": {
      "externalAssetsInFrance": false,
      "externalAssetsCountry": "ESP"
    }
  }
}

 

 

Réponse synchrone

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

{
  "id": "667158db37cd1e35c0d04f97",
  "externalRefId": "REF_API_01",
  "riskStatus": "NO_RISK_FOUND",
  "version": "2024-06-18T09:52:27.335Z",
  "sourceName": "CLIENTS",
  "identity": {
    "email": "",
    "firstName": "Maxime",
    "lastName": "HAUCHARD",
    "phoneNumber": "",
    "civility": "MR",
    "birth": {
      "date": "1990-01-31",
      "birthCity": "",
      "department": "Normandie",
      "country": "FRA",
      "nationality": "FRA"
    },
    "title": "",
    "maidenName": "",
    "nationality": "FRA",
    "socialSecurityNumber": "23452345678",
    "judicialProtectionRegime": "COURT_CUSTODY"
  },
  "proofOfId": {
    "number": "123456789",
    "issueDate": "2012-10-18",
    "type": "CNI",
    "issuer": "Préfecture de Paris"
  },
  "postalAddress": {
    "address": "1 rue Marie Curie",
    "zipCode": "75000",
    "city": "Paris",
    "country": "France"
  },
  "professionalInformation": {
    "professionalStatus": "profession",
    "career": "secteur d'activité",
    "sirenCode": "123456789",
    "expectedRetirementAge": "67",
    "companyAdditionalInformation": "companyName",
    "department": "companyService",
    "function": "Manager",
    "capacityLevel": "10",
    "isSupervisoryStaff": true,
    "isRemoteWorking": false,
    "shiftChangeDate": "2024-06-17T14:49:48.870Z",
    "contract": {
      "startDate": "2024-06-17T14:49:48.870Z",
      "endDate": "2024-06-17T14:49:48.870Z"
    },
    "naf": "A01_12Z",
    "socialProfessionalCategory": "L4_111A"
  },
  "insurerContracts": [
    {
      "type": "type",
      "number": "123456789",
      "insurer": "Assureur1",
      "startDate": "2022-01-31",
      "endDate": "2024-01-31"
    }
  ],
  "financialSituation": {
    "financialFlows": {
      "flowEmitterCountry": "ESP",
      "flowReceiverCountry": "FRA"
    },
    "financialAssets": {
      "externalAssetsInFrance": false,
      "externalAssetsCountry": "ESP"
    }
  }
}


Réponse asynchrone

Détails sur le swagger

Exemple de réponse obtenue si la personne physique a matché avec des correspondances pendant le filtrage, ce qui a conduit a un dossier de risque GDA, mais pas de dossier de risque PPE

{
  "eventId": "646dcb3f-ae57-4204-87d6-868f17074b66",
  "type": "ASYNC_RESPONSE",
  "data": {
    "naturalPersonData": {
      "naturalPerson": {
        "id": "667158db37cd1e35c0d04f97",
        "externalRefId": "REF_API_01",
        "riskStatus": "POTENTIAL_RISK",
        "version": "2024-06-18T09:52:27.335Z",
        "lastControlDate": "2024-06-18T09:52:30.959Z",
        "sourceName": "CLIENTS",
        "identity": {
          "email": "",
          "firstName": "Maxime",
          "lastName": "HAUCHARD",
          "phoneNumber": "",
          "civility": "MR",
          "birth": {
            "date": "1990-01-31",
            "birthCity": "",
            "department": "Normandie",
            "country": "FRA",
            "nationality": "FRA"
          },
          "title": "",
          "maidenName": "",
          "nationality": "FRA",
          "socialSecurityNumber": "23452345678",
          "judicialProtectionRegime": "COURT_CUSTODY"
        },
        "proofOfId": {
          "number": "123456789",
          "issueDate": "2012-10-18",
          "type": "CNI",
          "issuer": "Préfecture de Paris"
        },
        "postalAddress": {
          "address": "1 rue Marie Curie",
          "zipCode": "75000",
          "city": "Paris",
          "country": "France"
        },
        "professionalInformation": {
          "professionalStatus": "profession",
          "career": "secteur d'activité",
          "sirenCode": "123456789",
          "expectedRetirementAge": "67",
          "companyAdditionalInformation": "companyName",
          "department": "companyService",
          "function": "Manager",
          "capacityLevel": "10",
          "isSupervisoryStaff": true,
          "isRemoteWorking": false,
          "shiftChangeDate": "2024-06-17T14:49:48.870Z",
          "contract": {
            "startDate": "2024-06-17T14:49:48.870Z",
            "endDate": "2024-06-17T14:49:48.870Z"
          },
          "naf": "A01_12Z",
          "socialProfessionalCategory": "L4_111A"
        },
        "insurerContracts": [
          {
            "type": "type",
            "number": "123456789",
            "insurer": "Assureur1",
            "startDate": "2022-01-31",
            "endDate": "2024-01-31"
          }
        ],
        "financialSituation": {
          "financialFlows": {
            "flowEmitterCountry": "ESP",
            "flowReceiverCountry": "FRA"
          },
          "financialAssets": {
            "externalAssetsInFrance": false,
            "externalAssetsCountry": "ESP"
          }
        }
      },
      "personLinks": [],
      "personRiskHistorical": [
        {
          "id": "667158db37cd1e35c0d04f98",
          "riskStatus": "NO_RISK_FOUND",
          "userId": "625fdaed283a27647d0e0ca4",
          "userLogin": "user+api@beclm.com",
          "totalVigilanceRation": 0,
          "comments": [],
          "delaySincePreviousStatus": 0,
          "delaySinceLastAlert": 0
        },
        {
          "id": "667158de37cd1e35c0d04f99",
          "riskStatus": "POTENTIAL_RISK",
          "userId": "625fdaed283a27647d0e0ca4",
          "userLogin": user+api@beclm.com",
          "totalVigilanceRation": 87,
          "comments": [],
          "delaySincePreviousStatus": 3,
          "delaySinceLastAlert": 0
        }
      ]
    },
    "controlResults": {
      "EMPLOYEE_ADDITIONAL_DATA": {
        "type": "EMPLOYEE_ADDITIONAL_DATA",
        "controlResults": {},
        "completenessRatio": 100,
        "vigilanceRatio": 0
      },
      "FINANCIAL_SITUATION": {
        "type": "FINANCIAL_SITUATION",
        "controlResults": {},
        "completenessRatio": 0,
        "vigilanceRatio": 0
      },
      "MAIN_INFORMATION": {
        "type": "MAIN_INFORMATION",
        "controlResults": {
          "BaselControl": {
            "controlType": "BaselControl",
            "date": "2024-06-18T09:52:30.943Z",
            "score": 100,
            "status": "RISK"
          },
          "BlacklistControl": {
            "personDataSourceName": "CLIENTS",
            "externalRefId": "REF_API_01",
            "controlType": "BlacklistControl",
            "date": "2024-06-18T09:52:28.378Z",
            "score": 98,
            "blacklistPepStatus": "POTENTIAL_RISK",
            "riskFolderId": "667158dc6b07fb114843a6c0",
            "blacklistPepControlResultSnapshot": {
              "personControlResultId": "2024-06-18T09:52:28.378Z-BLACKLIST-649faedc-4cae-4a02-967a-bdf9c9b62a2a",
              "type": "BLACKLIST",
              "date": "2024-06-18T09:52:28.378Z",
              "controlListImports": [
                {
                  "dataImportId": "6499b6c5c6981a7dfd1abe4d",
                  "source": "LISTE_GDA_PRIVEE",
                  "totalEntries": 2,
                  "date": "2023-06-26T16:03:17.162Z"
                },
                {
                  "dataImportId": "6614f885440ca16c752e1af6",
                  "source": "SANCTIONS_RUSSIE",
                  "totalEntries": 5,
                  "date": "2024-04-09T08:12:53.534Z"
                },
                {
                  "dataImportId": "666bf21f0fc08c34360b0a76",
                  "source": "FR",
                  "totalEntries": 3809,
                  "date": "2024-06-14T07:32:46.550Z"
                },
                {
                  "dataImportId": "66705414f70dc1223edc729c",
                  "source": "UE",
                  "totalEntries": 3785,
                  "date": "2024-06-17T15:19:48.442Z"
                },
                {
                  "dataImportId": "6670d392f70dc1223edc7b0b",
                  "source": "ONU",
                  "totalEntries": 685,
                  "date": "2024-06-18T00:23:45.543Z"
                }
              ],
              "trigger": {
                "type": "MODULE",
                "login": "user+api@beclm.com"
              }
            },
            "status": "POTENTIAL_RISK"
          },
          "CspControl": {
            "controlType": "CspControl",
            "date": "2024-06-18T09:52:30.945Z",
            "score": 0,
            "status": "NO_RISK"
          },
          "EUControl": {
            "controlType": "EUControl",
            "date": "2024-06-18T09:52:30.941Z",
            "score": 100,
            "status": "RISK"
          },
          "GafiControl": {
            "controlType": "GafiControl",
            "date": "2024-06-18T09:52:30.940Z",
            "score": 100,
            "status": "HIGH_RISK"
          },
          "MilitaryControl": {
            "controlType": "MilitaryControl",
            "date": "2024-06-18T09:52:30.949Z",
            "score": 0,
            "status": "NO_RISK"
          },
          "NafControl": {
            "controlType": "NafControl",
            "date": "2024-06-18T09:52:30.947Z",
            "score": 100,
            "status": "RISK"
          },
          "NationalityControl": {
            "controlType": "NationalityControl",
            "date": "2024-06-18T09:52:30.951Z",
            "score": 0,
            "status": "NO_RISK"
          },
         "PepControl": {
            "personDataSourceName": "CLIENTS",
            "externalRefId": "REF_API_01",
            "controlType": "PepControl",
            "date": "2024-06-18T10:02:50.276Z",
            "score": 0,
            "blacklistPepStatus": "NO_RISK_FOUND",
            "blacklistPepControlResultSnapshot": {
              "personControlResultId": "2024-06-18T10:02:50.276Z-PEP-547151a1-bd22-433d-81bb-9cd251ebd0ef",
              "type": "PEP",
              "date": "2024-06-18T10:02:50.276Z",
              "controlListImports": [
                {
                  "dataImportId": "63a4189fd4f1b31275d69c59",
                  "source": "FR_LEADER",
                  "totalEntries": 3698,
                  "date": "2022-12-22T08:43:11.532Z"
                },
                {
                  "dataImportId": "63ff1adcbd836c30dc452120",
                  "source": "FR_CONSULS",
                  "totalEntries": 0,
                  "date": "2023-03-01T09:29:00.724Z"
                },
                {
                  "dataImportId": "64dc8e08b2ef8e37f1afef08",
                  "source": "FR_PARTIS-POLITIQUES",
                  "totalEntries": 1187,
                  "date": "2023-08-16T08:51:20.964Z"
                },
                {
                  "dataImportId": "64f074ccc751211912cb12b5",
                  "source": "Test CROATIE 5",
                  "totalEntries": 347,
                  "date": "2023-08-31T11:09:00.719Z"
                },
                {
                  "dataImportId": "65032e2f4887cb54f2f21410",
                  "source": "LISTE_PPE_PRIVEE",
                  "totalEntries": 5,
                  "date": "2023-09-14T16:00:47.311Z"
                },
                {
                  "dataImportId": "6585a6535e12de73fc254fab",
                  "source": "FR_MINISTERS",
                  "totalEntries": 2,
                  "date": "2023-12-22T15:07:08.176Z"
                },
                {
                  "dataImportId": "65f4515f0df0ff73f66aeb5c",
                  "source": "BENEFICIAL_OWNERS_COMPANIES_PUBLIC_RNE_NORMALIZED",
                  "totalEntries": 1670,
                  "date": "2024-03-15T13:47:04.475Z"
                },
                {
                  "dataImportId": "660d6f47e67dbc2d18ca3070",
                  "source": "FR_AMBASSADORS",
                  "totalEntries": 2,
                  "date": "2024-04-03T15:01:26.731Z"
                },
                {
                  "dataImportId": "660f41f3bbed2f1a053b19a3",
                  "source": "FR_INSTITUTION_JURISDICTIONS",
                  "totalEntries": 2,
                  "date": "2024-04-05T00:12:34.835Z"
                },
                {
                  "dataImportId": "6621b666684e4f4c26342464",
                  "source": "FR_SOLDIERS",
                  "totalEntries": 22,
                  "date": "2024-04-19T00:10:13.564Z"
                },
                {
                  "dataImportId": "664240a3a06c8d0db4d8d298",
                  "source": "FR_DEPUTIES",
                  "totalEntries": 577,
                  "date": "2024-05-13T16:32:35.350Z"
                },
                {
                  "dataImportId": "664240c7a06c8d0db4d8e9d8",
                  "source": "FR_SENATORS",
                  "totalEntries": 348,
                  "date": "2024-05-13T16:33:10.878Z"
                },
                {
                  "dataImportId": "666972153a04175379784e04",
                  "source": "FR_CENTRAL_BANKS",
                  "totalEntries": 491,
                  "date": "2024-06-12T10:01:57.577Z"
                },
                {
                  "dataImportId": "666a9a0af8f0d63875977c55",
                  "source": "PPE_BECLM_SPECIFIQUE",
                  "totalEntries": 376,
                  "date": "2024-06-13T07:04:42.939Z"
                },
                {
                  "dataImportId": "6670ee93f70dc1223edc7b45",
                  "source": "EU_DEPUTIES",
                  "totalEntries": 951,
                  "date": "2024-06-18T02:18:59.485Z"
                }
              ],
              "trigger": {
                "type": "MODULE",
                "login": "user+api@beclm.com"
              }
            },
            "status": "POTENTIAL_RISK"
          },
          "ResidenceControl": {
            "controlType": "ResidenceControl",
            "date": "2024-06-18T09:52:30.939Z",
            "score": 100,
            "status": "RISK"
          }
        },
        "completenessRatio": 80,
        "vigilanceRatio": 87
      },
      "NATURAL_PERSON_OVERVIEW": {
        "type": "NATURAL_PERSON_OVERVIEW",
        "controlResults": {},
        "completenessRatio": 60,
        "vigilanceRatio": 87
      },
      "REDFLAG_PEP": {
        "type": "REDFLAG_PEP",
        "controlResults": {
          "CspControl": {
            "controlType": "CspControl",
            "date": "2024-06-18T09:52:30.951Z",
            "score": 0,
            "status": "NO_RISK"
          },
          "ExternalAssetsCountryControl": {
            "controlType": "ExternalAssetsCountryControl",
            "date": "2024-06-18T09:52:30.958Z",
            "score": 0,
            "status": "NO_RISK"
          },
          "ExternalAssetsInFranceControl": {
            "controlType": "ExternalAssetsInFranceControl",
            "date": "2024-06-18T09:52:30.957Z",
            "score": 4,
            "status": "RISK"
          },
          "FlowEmitterCountryControl": {
            "controlType": "FlowEmitterCountryControl",
            "date": "2024-06-18T09:52:30.955Z",
            "score": 4,
            "status": "RISK"
          },
          "FlowReceiverCountryControl": {
            "controlType": "FlowReceiverCountryControl",
            "date": "2024-06-18T09:52:30.956Z",
            "score": 4,
            "status": "RISK"
          },
          "GafiControl": {
            "controlType": "GafiControl",
            "date": "2024-06-18T09:52:30.951Z",
            "score": 4,
            "status": "HIGH_RISK"
          },
          "NationalityControl": {
            "controlType": "NationalityControl",
            "date": "2024-06-18T09:52:30.954Z",
            "score": 0,
            "status": "NO_RISK"
          },
          "NaturalPersonNafControl": {
            "controlType": "NaturalPersonNafControl",
            "date": "2024-06-18T09:52:30.954Z",
            "score": 0,
            "status": "NO_RISK"
          }
        },
        "completenessRatio": 0,
        "vigilanceRatio": 0
      }
    },
    "riskStatus": "POTENTIAL_RISK"
  }
}