الانتقال إلى المحتوى الرئيسي

التحقق من البيانات

نقطة النهاية​

البيئةعنوان URL
الإنتاجPOST https://api.id.unico.app/lists/{cpf}
وضع الاختبارPOST https://api.id.uat.unico.app/lists/{cpf}
نقطة نهاية منفصلة بتصميم مقصود

هذه النقطة النهائية منفصلة عن إنشاء العملية القياسية (POST /processes/v1). تُرجع قائمة من البيانات — وليس نتيجة تحقق حتمية من الهوية.

الطلب​

الترويسات
الترويسةالقيمة
AuthorizationBearer <access_token> (انظر المصادقة)
معاملات المسار
المعاملالنوعمطلوبالوصف
cpfstringنعمرقم CPF للشخص المراد الاستعلام عنه.
curl -X POST "https://api.id.uat.unico.app/lists/12345678909" \
  -H "Authorization: Bearer $TOKEN"

الاستجابة​

المغلّف الجذري
{
  "id": "41c24382-36ce-4bb4-8339-352114f71f78",
  "status": 3,
  "lists": { }
}
الحقلالنوعالوصف
idstring (UUID)معرّف الطلب الفريد.
statusintegerحالة المعالجة.
listsobjectالحمولة الرئيسية التي تحتوي على البيانات المستعلَم عنها.
`lists.basicData` — بيانات التسجيل
{
  "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"
  }
}
الحقلالنوعالوصف
namestringالاسم الكامل.
birthCountrystringبلد الميلاد.
birthDatestring (ISO 8601)تاريخ الميلاد.
genderstringالجنس.
motherNamestringاسم الأم.
fatherNamestringاسم الأب.
maritalStatusstringالحالة الاجتماعية.
rgNumberstringرقم وثيقة RG.
rgIssuingAgencystringالجهة المُصدِرة لوثيقة RG.
rgStateCodestringرمز الولاية في وثيقة RG.
financialData.incomeEstimatestringتقدير الدخل.
financialData.totalAssetsstringإجمالي الأصول.
emailstringالبريد الإلكتروني.
phonestringرقم الهاتف.

basicData.address:

الحقلالنوعالوصف
addressMainstringاسم الشارع.
numberstringالرقم.
complementstringتكملة العنوان.
neighborhoodstringالحي.
zipCodestringالرمز البريدي.
citystringالمدينة.
statestringرمز الولاية.
countrystringالبلد.
typestringنوع العنوان (مثال: WORK).
`lists.riskData.taxIdValidation` — التحقق من رقم CPF
{
  "taxIdValidation": {
    "taxIdStatus": "REGULAR",
    "taxIdStatusDate": "...",
    "decease": false,
    "under18": false
  }
}
الحقلالنوعالوصف
taxIdStatusstringحالة تسجيل رقم CPF.
taxIdStatusDatestringتاريخ حالة التسجيل.
deceasebooleanيشير إلى الوفاة.
under18booleanيشير إلى أن عمر الشخص أقل من 18 عاماً.
`lists.riskData.pep` — الشخص المعرَّض سياسياً
{
  "pep": {
    "isCurrentlyPep": true,
    "records": [
      {
        "level": "1",
        "jobTitle": "SENADOR",
        "motive": "FEDERAL EMPLOYEE"
      }
    ]
  }
}
الحقلالنوعالوصف
isCurrentlyPepbooleanهل الشخص معرَّض سياسياً حالياً.
recordsarrayسجلات التعرض السياسي الخاصة بالشخص.
records[].levelstringمستوى التعرض السياسي.
records[].jobTitlestringالمسمى الوظيفي.
records[].motivestringسبب التصنيف.
`lists.riskData.aml` — مكافحة غسيل الأموال (العقوبات)
{
  "aml": {
    "isSanctioned": true,
    "records": [
      {
        "type": "Law Enforcement",
        "source": "interpol",
        "standardizedType": "ARREST WARRANTS",
        "endDate": "..."
      }
    ]
  }
}
الحقلالنوعالوصف
isSanctionedbooleanهل الشخص خاضع للعقوبات.
recordsarrayالعقوبات الخاصة بالشخص.
records[].typestringنوع العقوبة.
records[].sourcestringمصدر العقوبة.
records[].standardizedTypestringالنوع الموحَّد.
records[].endDatestringتاريخ الانتهاء.
`lists.riskData.sportsRelationship` — العلاقة بالمراهنات الرياضية
{
  "sportsRelationship": {
    "hasSportsRelationship": false,
    "isCurrentlyAthlete": false,
    "isCurrentlySportsCoach": false,
    "isCurrentlySportsClubDirector": false,
    "isCurrentlyReferee": false,
    "isCurrentlyRelatedToFinanceMinistry": false,
    "isCurrentlyBettingCompanyOwner": false,
    "sportsRelationshipMotive": "",
    "sportExposures": []
  }
}
الحقلالنوعالوصف
hasSportsRelationshipbooleanوجود علاقة رياضية.
isCurrentlyAthletebooleanهل الشخص رياضي نشط.
isCurrentlySportsCoachbooleanهل الشخص مدرب رياضي نشط.
isCurrentlySportsClubDirectorbooleanهل الشخص مدير نادٍ رياضي نشط.
isCurrentlyRefereebooleanهل الشخص حكَم نشط.
isCurrentlyRelatedToFinanceMinistrybooleanوجود علاقة بوزارة المالية.
isCurrentlyBettingCompanyOwnerbooleanهل الشخص مالك شركة مراهنات.
sportsRelationshipMotivestringسبب العلاقة.
sportExposuresarrayتفاصيل التعرضات الرياضية.

sportExposures[]:

الحقلالنوعالوصف
sportNamestringاسم الرياضة.
regionstringمنطقة النشاط.
totalRelatedEntitiesintegerإجمالي الكيانات المرتبطة.
relationshipLevelstringمستوى العلاقة.
endDatestringتاريخ الانتهاء.

رموز الخطأ​

الرمزالرسالةالوصف
99989The document is invalid.عندما يكون رقم CPF غير صالح.
آخر تحديث في