Aller au contenu principal

Vérification des données

MarkdownChatGPTClaude

Point de terminaison​

EnvironnementURL
ProductionPOST https://api.idcloud.unico.app/lists/{cpf}
SandboxPOST https://api.idcloud.uat.unico.app/lists/{cpf}
Point de terminaison distinct, par conception

Ce point de terminaison est distinct de la création de processus standard (POST /processes/v1). Il fournit une liste de données — et non un résultat déterministe de vérification d'identité.

Requête​

En-têtes
En-têteValeur
AuthorizationBearer <access_token> (voir Authentification)
Paramètres de chemin
ParamètreTypeObligatoireDescription
cpfstringouiCPF de la personne à interroger.
curl -X POST "https://api.idcloud.uat.unico.app/lists/12345678909" \
-H "Authorization: Bearer $TOKEN"

Réponse​

Enveloppe racine
{
"id": "41c24382-36ce-4bb4-8339-352114f71f78",
"status": 3,
"lists": { }
}
ChampTypeDescription
idstring (UUID)Identifiant unique de la requête.
statusintegerStatut du traitement.
listsobjectCharge utile principale contenant les données demandées.

`lists.basicData` — Données d'enregistrement
{
"basicData": {
"name": "JOAO DA SILVA",
"birthCountry": "BRASILEIRA",
"birthDate": "1990-01-01T00:00:00Z",
"gender": "M",
"motherName": "MARIA DA SILVA",
"fatherName": "",
"maritalStatus": "",
"rgNumber": "",
"rgIssuingAgency": "",
"rgStateCode": "",
"financialData": {
"incomeEstimate": "...",
"totalAssets": "..."
},
"address": {
"addressMain": "AVENIDA DO ESTADO",
"number": "123",
"complement": "ANDAR 1",
"neighborhood": "CENTRO",
"zipCode": "12345678",
"city": "SAO PAULO",
"state": "SP",
"country": "BRASIL",
"type": "WORK"
},
"email": "...",
"phone": "+554799999999",
"socialName": ""
}
}
ChampTypeDescription
namestringNom complet.
birthCountrystringPays de naissance.
birthDatestring (ISO 8601)Date de naissance.
genderstringGenre.
motherNamestringNom de la mère.
fatherNamestringNom du père.
maritalStatusstringÉtat civil.
rgNumberstringNuméro du RG.
rgIssuingAgencystringOrganisme émetteur du RG.
rgStateCodestringCode de l'État du RG.
financialData.​incomeEstimatestringEstimation des revenus.
financialData.​totalAssetsstringTotal des actifs.
emailstringE-mail.
phonestringTéléphone.
socialNamestringNom social. Peut être vide si la personne n'a pas de nom social enregistré.

basicData.address:

ChampTypeDescription
addressMainstringNom de la rue.
numberstringNuméro.
complementstringComplément.
neighborhoodstringQuartier.
zipCodestringCode postal.
citystringVille.
statestringCode de l'État.
countrystringPays.
typestringType d'adresse (ex. WORK).

`lists.riskData.taxIdValidation` — Validation du CPF
{
"taxIdValidation": {
"taxIdStatus": "REGULAR",
"taxIdStatusDate": "...",
"decease": false,
"under18": false
}
}
ChampTypeDescription
taxIdStatusstringStatut d'enregistrement du CPF.
taxIdStatusDatestringDate du statut d'enregistrement.
deceasebooleanIndique un décès.
under18booleanIndique une personne mineure (moins de 18 ans).

`lists.riskData.pep` — Personne politiquement exposée
{
"pep": {
"isCurrentlyPep": true,
"records": [
{
"level": "1",
"jobTitle": "SENADOR",
"motive": "FEDERAL EMPLOYEE"
}
]
}
}
ChampTypeDescription
isCurrentlyPepbooleanEst actuellement une PPE.
recordsarrayAntécédents PPE propres à la personne.
records[].levelstringNiveau d'exposition politique.
records[].jobTitlestringFonction occupée.
records[].motivestringMotif de classification.

`lists.riskData.aml` — Lutte contre le blanchiment d'argent (Sanctions)
{
"aml": {
"isSanctioned": true,
"records": [
{
"type": "Law Enforcement",
"source": "interpol",
"standardizedType": "ARREST WARRANTS",
"endDate": "..."
}
]
}
}
ChampTypeDescription
isSanctionedbooleanFait l'objet d'une sanction.
recordsarraySanctions propres à la personne.
records[].typestringType de sanction.
records[].sourcestringSource de la sanction.
records[].​standardizedTypestringType normalisé.
records[].endDatestringDate de fin.

`lists.riskData.sportsRelationship` — Relation avec les paris sportifs
{
"sportsRelationship": {
"hasSportsRelationship": false,
"isCurrentlyAthlete": false,
"isCurrentlySportsCoach": false,
"isCurrentlySportsClubDirector": false,
"isCurrentlyReferee": false,
"isCurrentlyRelatedToFinanceMinistry": false,
"isCurrentlyBettingCompanyOwner": false,
"sportsRelationshipMotive": "",
"sportExposures": []
}
}
ChampTypeDescription
hasSportsRelationshipbooleanA une relation avec le sport.
isCurrentlyAthletebooleanEst un athlète en activité.
isCurrentlySportsCoachbooleanEst un entraîneur en activité.
isCurrentlySportsClubDirectorbooleanEst un dirigeant de club en activité.
isCurrentlyRefereebooleanEst un arbitre en activité.
isCurrentlyRelatedToFinanceMinistrybooleanA une relation avec le ministère des Finances.
isCurrentlyBettingCompanyOwnerbooleanEst propriétaire d'une société de paris.
sportsRelationshipMotivestringMotif de la relation.
sportExposuresarrayExpositions sportives détaillées.

sportExposures[]:

ChampTypeDescription
sportNamestringNom du sport.
regionstringRégion d'activité.
totalRelatedEntitiesintegerTotal des entités liées.
relationshipLevelstringNiveau de relation.
endDatestringDate de fin.

Codes d'erreur​

CodeMessageDescription
99989The document is invalid.Lorsque le CPF est invalide.