BeCLM - Documentation APIs
Breadcrumbs

GET INFO RISK PP KYC

Cet endpoint de l'API permet de récupérer les informations et résultats de contrôle d'une personne physique existante dans KYC, à partir de sa référence externe.


Description

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


Méthode

GET


Paramètres d’entrée

Param

Type

Description

Exemple

sourceName

String

Nom technique de la source sur laquelle se trouve la personne physique

CLIENTS

externalRefId

String

La référence de la personne physique dont on souhaite récupérer les informations

134679852


Réponse synchrone

Exemple de réponse obtenue :

{
  "person": {
    "externalRefId": "API_PP_1234",
    "sourceName": "NGT_SOURCE_KYC",
    "personIntegratedData": {
      "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"
        }
      ],
      "identity": {
        "email": "test@test.com",
        "firstName": "Michel",
        "lastName": "MARTIN",
        "phoneNumber": "0123456789",
        "mobilePhoneNumber": "0612345678",
        "civility": "MR",
        "birth": {
          "date": "1995-01-01",
          "birthCity": "Bordeaux",
          "department": "department",
          "country": "FRA",
          "nationality": "FRA"
        },
        "title": "professor",
        "maidenName": "maidenName",
        "nationality": "FRA",
        "personType": "personType",
        "legalForm": "legalForm",
        "socialSecurityNumber": "socialSecurityNumber",
        "judicialProtectionRegime": "TUTELAGE"
      },
      "postalAddress": {
        "address": "1 rue du test",
        "zipCode": "40500",
        "city": "COUDURES",
        "country": "FRA",
        "building": "Appartement 01"
      },
      "professionalInformation": {
        "professionalStatus": "professional status",
        "career": "career",
        "sirenCode": "sirenCode",
        "expectedRetirementAge": "expectedRetirementAge",
        "companyAdditionalInformation": "companyAdditionalInformation",
        "department": "department",
        "function": "function",
        "capacityLevel": "capacityLevel",
        "isSupervisoryStaff": true,
        "isRemoteWorking": true,
        "shiftChangeDate": "2020-01-01T00:00:00Z",
        "contract": {
          "startDate": "2020-01-01T00:00:00Z",
          "endDate": "2021-01-01T00:00:00Z"
        },
        "naf": "B06_10Z",
        "socialProfessionalCategory": "L4_111A"
      },
      "financialSituation": {
        "financialWealth": {
          "totalFinancialWealth": 675500.5
        },
        "yearlyIncomes": 35000,
        "financialAssets": {
          "externalAssetsInFrance": true,
          "externalAssetsCountry": "USA"
        },
        "financialFlows": {
          "flowEmitterCountry": "BEL",
          "flowReceiverCountry": "FRA"
        }
      },
      "proofOfId": {
        "number": "123456",
        "issueDate": "2020-01-01",
        "type": "type",
        "issuer": "issuer"
      }
    },
    "externalApiData": {},
    "controlsData": {
      "riskStatus": "NO_RISK_FOUND",
      "lastControlDate": "2026-01-21T14:30:52.160Z",
      "controlResults": [
        {
          "controlFamilyId": "66f543f20b4fa14dc6dae17a",
          "controlFamilyName": "Risques LCB-FT",
          "controlTypeId": 0,
          "controlTypeName": "BlacklistControl",
          "date": "2026-01-21T14:30:51.424Z",
          "computed": true,
          "score": 0,
          "status": "NO_RISK_FOUND",
          "description": "Contrôle GDA",
          "type": "BLACKLIST_PEP"
        },
        {
          "controlFamilyId": "66f543f20b4fa14dc6dae17a",
          "controlFamilyName": "Risques LCB-FT",
          "controlTypeId": 1,
          "controlTypeName": "PepControl",
          "date": "2026-01-21T14:30:51.785Z",
          "computed": false,
          "status": "NOT_COMPUTABLE",
          "description": "Contrôle PPE",
          "type": "BLACKLIST_PEP"
        },
        {
          "controlFamilyId": "66f543f20b4fa14dc6dae17a",
          "controlFamilyName": "Risques LCB-FT",
          "controlTypeId": 3,
          "controlTypeName": "GafiControl",
          "date": "2026-01-21T14:30:51.841Z",
          "computed": true,
          "score": 0,
          "status": "NO_RISK_FOUND",
          "description": "Pays de résidence fiscal : FRA - France",
          "controlData": "FRA - France",
          "type": "THRESHOLD"
        },
        {
          "controlFamilyId": "66f543f20b4fa14dc6dae17a",
          "controlFamilyName": "Risques LCB-FT",
          "controlTypeId": 5,
          "controlTypeName": "EUControl",
          "date": "2026-01-21T14:30:51.855Z",
          "computed": true,
          "score": 0,
          "status": "NO_RISK_FOUND",
          "description": "Pays de résidence fiscal : FRA - France",
          "controlData": "FRA - France",
          "type": "THRESHOLD"
        },
        {
          "controlFamilyId": "68187f1e015d20f8f0a2d8c3",
          "controlFamilyName": "Corruption",
          "controlTypeId": 13,
          "controlTypeName": "NationalityControl",
          "date": "2026-01-21T14:30:51.859Z",
          "computed": true,
          "score": 0,
          "status": "NO_RISK_FOUND",
          "description": "Nationalité : FRA - France",
          "controlData": "FRA - France",
          "type": "THRESHOLD"
        },
        {
          "controlFamilyId": "66f543f20b4fa14dc6dae17e",
          "controlFamilyName": "Risques BODACC",
          "controlTypeId": 14,
          "controlTypeName": "FlowEmitterCountryControl",
          "date": "2026-01-21T14:30:51.884Z",
          "computed": true,
          "score": 17,
          "status": "NO_RISK_FOUND",
          "description": "Pays émetteur de flux financiers : BEL - Belgique",
          "controlData": "BEL - Belgique",
          "type": "THRESHOLD"
        },
        {
          "controlFamilyId": "68187f1e015d20f8f0a2d8c8",
          "controlFamilyName": "Risque client",
          "controlTypeId": 28,
          "controlTypeName": "AdverseMediaControl",
          "date": "2026-01-21T14:30:51.978Z",
          "computed": true,
          "score": 0,
          "status": "NO_RISK_FOUND",
          "description": "Contrôle AM",
          "type": "BLACKLIST_PEP"
        },
        {
          "controlFamilyId": "68187f1e015d20f8f0a2d8c8",
          "controlFamilyName": "Risque client",
          "controlTypeId": 29,
          "controlTypeName": "DeceasedControl",
          "date": "2026-01-21T14:30:52.133Z",
          "computed": true,
          "score": 0,
          "status": "NO_RISK_FOUND",
          "description": "Nom : Civil, Prénom(s) : Bartabé, Date de naissance : 01/01/1995",
          "controlData": "Civil - Bartabé - 01/01/1995",
          "type": "THRESHOLD"
        },
        {
          "controlFamilyId": "68187f1e015d20f8f0a2d8c3",
          "controlFamilyName": "Corruption",
          "controlTypeId": 1018,
          "controlTypeName": "",
          "date": "2026-01-21T14:30:52.142Z",
          "computed": true,
          "status": "NOT_COMPUTABLE",
          "description": "",
          "type": "THRESHOLD"
        },
        {
          "controlFamilyId": "68187f1e015d20f8f0a2d8c3",
          "controlFamilyName": "Corruption",
          "controlTypeId": 1021,
          "controlTypeName": "",
          "date": "2026-01-21T14:30:52.152Z",
          "computed": true,
          "score": 0,
          "status": "NO_RISK_FOUND",
          "description": "FRA",
          "controlData": "FRA",
          "type": "THRESHOLD"
        },
        {
          "controlFamilyId": "68187f1e015d20f8f0a2d8c3",
          "controlFamilyName": "Corruption",
          "controlTypeId": 1022,
          "controlTypeName": "",
          "date": "2026-01-21T14:30:52.160Z",
          "computed": true,
          "status": "NOT_COMPUTABLE",
          "description": "",
          "type": "THRESHOLD"
        },
        {
          "controlFamilyId": "68baea3f41b134654a069c0a",
          "controlFamilyName": "Statut de vigilance",
          "controlTypeId": 56,
          "controlTypeName": "VigilanceControl",
          "date": "2026-01-21T14:30:52.172Z",
          "computed": true,
          "score": 0,
          "status": "NO_RISK_FOUND",
          "description": "Données et résultats de contrôle de la personne",
          "vigilanceStatus": "NO_VIGILANCE_STATUS",
          "type": "VIGILANCE"
        }
      ],
      "pcrId": "2026-01-21T14:30:52.160Z-KYC-3d7a025a-10bd-4b36-bcf0-fa9e14b733c3"
    },
    "active": true,
    "type": "NATURAL"
  },
  "personLinks": {
    "BENEFICIAL_OWNER": 0,
    "REPRESENTATIVE": 0,
    "ENTREPRENEUR": 0
  }
}