Aller au contenu principal

Vérification des données

Point de terminaison​

EnvironnementURL
ProductionPOST https://api.id.unico.app/lists/{cpf}
SandboxPOST https://api.id.uat.unico.app/lists/{cpf}
Point de terminaison séparé par conception

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

Requête​

En-têtes
En-têteValeur
AuthorizationBearer <access_token> (voir Authentification)
Paramètres de chemin
ParamètreTypeRequisDescription
cpfstringouiCPF de la personne à interroger.
curl -X POST "https://api.id.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 de traitement.
listsobjectCharge utile principale avec les données interrogé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"
  }
}
ChampTypeDescription
namestringNom complet.
birthCountrystringPays de naissance.
birthDatestring (ISO 8601)Date de naissance.
genderstringGenre.
motherNamestringNom de la mère.
fatherNamestringNom du père.
maritalStatusstringSituation matrimoniale.
rgNumberstringNuméro RG.
rgIssuingAgencystringOrganisme émetteur du RG.
rgStateCodestringCode d'état du RG.
financialData.incomeEstimatestringEstimation des revenus.
financialData.totalAssetsstringTotal des actifs.
emailstringE-mail.
phonestringTéléphone.

basicData.address :

ChampTypeDescription
addressMainstringNom de la rue.
numberstringNuméro.
complementstringComplément.
neighborhoodstringQuartier.
zipCodestringCode postal.
citystringVille.
statestringCode d'é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 de moins de 18 ans.
`lists.riskData.pep` — Personne Politiquement Exposée
{
  "pep": {
    "isCurrentlyPep": true,
    "records": [
      {
        "level": "1",
        "jobTitle": "SENADOR",
        "motive": "FEDERAL EMPLOYEE"
      }
    ],
    "hasRelatedPep": true,
    "related": [
      {
        "taxId": "01253069891",
        "level": "2",
        "jobTitle": "FAMILIAR"
      }
    ]
  }
}
ChampTypeDescription
isCurrentlyPepbooleanEst actuellement une PPE.
recordsarrayPropres enregistrements PPE.
records[].levelstringNiveau d'exposition politique.
records[].jobTitlestringTitre du poste.
records[].motivestringMotif de classification.
hasRelatedPepbooleanPossède des personnes liées à une PPE.
relatedarrayListe des personnes liées à une PPE.
related[].taxIdstringCPF de la personne liée.
related[].levelstringNiveau d'exposition.
related[].jobTitlestringTitre du poste de la personne liée.
`lists.riskData.aml` — Lutte contre le blanchiment d'argent (Sanctions)
{
  "aml": {
    "isSanctioned": true,
    "records": [
      {
        "type": "Law Enforcement",
        "source": "interpol",
        "standardizedType": "ARREST WARRANTS",
        "endDate": "..."
      }
    ],
    "hasRelatedSanctioned": false,
    "relatedRecords": []
  }
}
ChampTypeDescription
isSanctionedbooleanEst sanctionné.
recordsarrayPropres sanctions.
records[].typestringType de sanction.
records[].sourcestringSource de la sanction.
records[].standardizedTypestringType standardisé.
records[].endDatestringDate de fin.
hasRelatedSanctionedbooleanPossède des personnes liées sanctionnées.
relatedRecordsarraySanctions des personnes liées.
`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
hasSportsRelationshipbooleanPossède une relation sportive.
isCurrentlyAthletebooleanEst un athlète actif.
isCurrentlySportsCoachbooleanEst un entraîneur actif.
isCurrentlySportsClubDirectorbooleanEst un directeur de club actif.
isCurrentlyRefereebooleanEst un arbitre actif.
isCurrentlyRelatedToFinanceMinistrybooleanPossède 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 la relation.
endDatestringDate de fin.

Codes d'erreur​

CodeMessageDescription
99989The document is invalid.Lorsque le CPF est invalide.
Dernière mise à jour le