Cet endpoint de l'API permet de créer ou mettre à jour les informations d'une personne physique, et de lancer le filtrage.
Une réponse synchrone est reçue suite à la création ou mise à jour de la personne physique.
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 |
|---|---|---|---|
|
|
String |
Nom technique de la source sur laquelle la personne physique va être créée |
CLIENTS |
|
|
String |
La référence de la personne physique 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"
}
],
"identity": {
"email": "test@test.com",
"firstName": "firstName",
"lastName": "lastName",
"phoneNumber": "0123456789",
"mobilePhoneNumber": "0612345678",
"civility": "MR",
"birth": {
"date": "1997-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",
"legalEntityRef": {
"sourceName": "sourceName",
"externalRefId": "externalRefId"
}
},
"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"
}
}
Réponse synchrone
Exemple de réponse obtenue quand la personne physique 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"
}
],
"identity": {
"email": "test@test.com",
"firstName": "Bartabé",
"lastName": "Civil",
"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"
}
}
Réponse asynchrone
Exemple de réponse asynchrone obtenue :
{
"eventId": "cbec43c3-d22a-4988-b88a-0d37849f4231",
"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ées 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ées Client",
"riskFolderId": "88fa8d123bce49b2393139f0",
"type": "BLACKLIST_PEP"
},
{
"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": 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"
}