डेटा सत्यापन
Endpoint
| परिवेश | URL |
|---|---|
| Production | POST https://api.id.unico.app/lists/{cpf} |
| Sandbox | POST https://api.id.uat.unico.app/lists/{cpf} |
डिज़ाइन द्वारा अलग endpoint
यह endpoint मानक process निर्माण (POST /processes/v1) से अलग है। यह डेटा की एक सूची प्रदान करता है — कोई निर्धारात्मक पहचान सत्यापन परिणाम नहीं।
अनुरोध
Headers
| Header | मान |
|---|---|
Authorization | Bearer <access_token> (देखें Authentication) |
Path parameters
| पैरामीटर | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
cpf | string | हाँ | क्वेरी करने वाले व्यक्ति का CPF। |
curl -X POST "https://api.id.uat.unico.app/lists/12345678909" \
-H "Authorization: Bearer $TOKEN"
प्रतिक्रिया
Root envelope
{
"id": "41c24382-36ce-4bb4-8339-352114f71f78",
"status": 3,
"lists": { }
}
| फ़ील्ड | प्रकार | विवरण |
|---|---|---|
id | string (UUID) | अद्वितीय अनुरोध पहचानकर्ता। |
status | integer | प्रसंस्करण स्थिति। |
lists | object | क्वेरी किए गए डेटा के साथ मुख्य पेलोड। |
`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",
"socialName": ""
}
}
| फ़ील्ड | प्रकार | विवरण |
|---|---|---|
name | string | पूरा नाम। |
birthCountry | string | जन्म का देश। |
birthDate | string (ISO 8601) | जन्म तिथि। |
gender | string | लिंग। |
motherName | string | माता का नाम। |
fatherName | string | पिता का नाम। |
maritalStatus | string | वैवाहिक स्थिति। |
rgNumber | string | RG संख्या। |
rgIssuingAgency | string | RG जारी करने वाली एजेंसी। |
rgStateCode | string | RG राज्य कोड। |
financialData.incomeEstimate | string | आय अनुमान। |
financialData.totalAssets | string | कुल संपत्ति। |
email | string | ईमेल। |
phone | string | फ़ोन। |
socialName | string | सामाजिक नाम। यदि व्यक्ति का कोई पंजीकृत सामाजिक नाम नहीं है, तो यह खाली हो सकता है। |
basicData.address:
| फ़ील्ड | प्रकार | विवरण |
|---|---|---|
addressMain | string | सड़क का नाम। |
number | string | नंबर। |
complement | string | पूरक। |
neighborhood | string | मोहल्ला। |
zipCode | string | ZIP कोड। |
city | string | शहर। |
state | string | राज्य कोड। |
country | string | देश। |
type | string | पता प्रकार (उदा., WORK)। |
`lists.riskData.taxIdValidation` — CPF सत्यापन
{
"taxIdValidation": {
"taxIdStatus": "REGULAR",
"taxIdStatusDate": "...",
"decease": false,
"under18": false
}
}
| फ़ील्ड | प्रकार | विवरण |
|---|---|---|
taxIdStatus | string | CPF पंजीकरण स्थिति। |
taxIdStatusDate | string | पंजीकरण स्थिति की तिथि। |
decease | boolean | मृत्यु का संकेत देता है। |
under18 | boolean | 18 वर्ष से कम आयु का संकेत देता है। |
`lists.riskData.pep` — राजनीतिक रूप से उजागर व्यक्ति
{
"pep": {
"isCurrentlyPep": true,
"records": [
{
"level": "1",
"jobTitle": "SENADOR",
"motive": "FEDERAL EMPLOYEE"
}
]
}
}
| फ़ील्ड | प्रकार | विवरण |
|---|---|---|
isCurrentlyPep | boolean | वर्तमान में PEP है। |
records | array | स्वयं के PEP रिकॉर्ड। |
records[].level | string | राजनीतिक एक्सपोज़र का स्तर। |
records[].jobTitle | string | पद का शीर्षक। |
records[].motive | string | वर्गीकरण का कारण। |
`lists.riskData.aml` — धन-शोधन विरोधी (प्रतिबंध)
{
"aml": {
"isSanctioned": true,
"records": [
{
"type": "Law Enforcement",
"source": "interpol",
"standardizedType": "ARREST WARRANTS",
"endDate": "..."
}
]
}
}
| फ़ील्ड | प्रकार | विवरण |
|---|---|---|
isSanctioned | boolean | प्रतिबंधित है। |
records | array | स्वयं के प्रतिबंध। |
records[].type | string | प्रतिबंध का प्रकार। |
records[].source | string | प्रतिबंध का स्रोत। |
records[].standardizedType | string | मानकीकृत प्रकार। |
records[].endDate | string | समाप्ति तिथि। |
`lists.riskData.sportsRelationship` — खेल सट्टेबाजी संबंध
{
"sportsRelationship": {
"hasSportsRelationship": false,
"isCurrentlyAthlete": false,
"isCurrentlySportsCoach": false,
"isCurrentlySportsClubDirector": false,
"isCurrentlyReferee": false,
"isCurrentlyRelatedToFinanceMinistry": false,
"isCurrentlyBettingCompanyOwner": false,
"sportsRelationshipMotive": "",
"sportExposures": []
}
}
| फ़ील्ड | प्रकार | विवरण |
|---|---|---|
hasSportsRelationship | boolean | खेल संबंध है। |
isCurrentlyAthlete | boolean | सक्रिय खिलाड़ी है। |
isCurrentlySportsCoach | boolean | सक्रिय कोच है। |
isCurrentlySportsClubDirector | boolean | सक्रिय क्लब निदेशक है। |
isCurrentlyReferee | boolean | सक्रिय रेफरी है। |
isCurrentlyRelatedToFinanceMinistry | boolean | वित्त मंत्रालय से संबंध है। |
isCurrentlyBettingCompanyOwner | boolean | सट्टेबाजी कंपनी का मालिक है। |
sportsRelationshipMotive | string | संबंध का कारण। |
sportExposures | array | विस्तृत खेल एक्सपोज़र। |
sportExposures[]:
| फ़ील्ड | प्रकार | विवरण |
|---|---|---|
sportName | string | खेल का नाम। |
region | string | गतिविधि का क्षेत्र। |
totalRelatedEntities | integer | कुल संबंधित संस्थाएँ। |
relationshipLevel | string | संबंध स्तर। |
endDate | string | समाप्ति तिथि। |
त्रुटि कोड
- 400 Bad Request
- 403 Forbidden
- 500 Internal Server Error
| कोड | संदेश | विवरण |
|---|---|---|
99989 | The document is invalid. | जब CPF अमान्य हो। |
| कोड | संदेश | विवरण |
|---|---|---|
10501 | The authorization token is invalid. | प्रमाणीकरण टोकन अमान्य है। |
| कोड | संदेश | विवरण |
|---|---|---|
99999 | Internal failure! Try again later | जब कोई आंतरिक त्रुटि हो। |