{
"document_type": "cpf",
"input_value": "11144477735",
"formatted_value": "111.444.777-35",
"is_valid": true
}
curl --location --request GET 'https://zylalabs.com/api/13818/brazilian+document+validator+api/31683/validate+cpf&cpf=Required' --header 'Authorization: Bearer YOUR_API_KEY'
{
"document_type": "cnpj",
"input_value": "11222333000181",
"formatted_value": "11.222.333/0001-81",
"is_valid": true
}
curl --location --request GET 'https://zylalabs.com/api/13818/brazilian+document+validator+api/31684/validate+cnpj&cnpj=Required' --header 'Authorization: Bearer YOUR_API_KEY'
{
"document_type": "cnh",
"input_value": "12345678900",
"formatted_value": null,
"is_valid": true
}
curl --location --request GET 'https://zylalabs.com/api/13818/brazilian+document+validator+api/31685/validate+cnh&cnh=Required' --header 'Authorization: Bearer YOUR_API_KEY'
साइन अप करने के बाद, प्रत्येक डेवलपर को एक पर्सनल API एक्सेस की असाइन की जाती है, जो अक्षरों और अंकों का एक यूनिक संयोजन होता है, जिसका उपयोग हमारे API एंडपॉइंट तक पहुंचने के लिए किया जाता है। प्रमाणीकरण के लिए ब्राज़ीलियाई दस्तावेज़ सत्यापनकर्ता API के साथ बस अपने बेयरर टोकन को Authorization हेडर में शामिल करें।
| हेडर | विवरण |
|---|---|
Authorization
|
आवश्यक
होना चाहिए Bearer access_key. जब आप सब्सक्राइब हों तो ऊपर "Your API Access Key" देखें।
|
कोई लंबी अवधि की प्रतिबद्धता नहीं। कभी भी अपग्रेड, डाउनग्रेड या कैंसल करें। फ्री ट्रायल में 50 रिक्वेस्ट तक शामिल हैं।
प्रत्येक एंडपॉइंट ब्राज़ीलियाई दस्तावेज़ों के लिए सत्यापन डेटा लौटाता है: CPF, CNPJ, और CNH। प्रतिक्रिया में दस्तावेज़ का प्रकार, इनपुट मान, स्वरूपित मान (यदि लागू हो) और एक वैधता स्थिति शामिल होती है जो बताती है कि दस्तावेज़ मान्य है या नहीं
प्रतिक्रिया डेटा के मुख्य क्षेत्रों में `document_type` (जो दस्तावेज़ के प्रकार को दर्शाता है), `input_value` (मूल इनपुट), `formatted_value` (संरचित दस्तावेज़ संख्या), और `is_valid` (एक बूलियन जो वैधता को दर्शाता है) शामिल हैं
प्रतिक्रिया डेटा को JSON प्रारूप में व्यवस्थित किया गया है प्रत्येक प्रतिक्रिया में ऐसे फ़ील्ड होते हैं जो दस्तावेज़ प्रकार मूल इनपुट इसके स्वरूपित संस्करण और इसकी वैधता स्थिति की जानकारी प्रदान करते हैं जिससे इसे पार्स और उपयोग करना आसान हो जाता है
प्रत्येक एंडपॉइंट विशेष ब्राज़िलियाई दस्तावेजों के लिए सत्यापन जानकारी प्रदान करता है: CPF (व्यक्तिगत करदाता आईडी), CNPJ (कंपनी करदाता आईडी) और CNH (ड्राइवर का लाइसेंस) इसमें यह शामिल है कि दस्तावेज़ मान्य है या नहीं और इसका स्वरूपित प्रतिनिधित्व
एंडपॉइंट दस्तावेज नंबरों को पैरामीटर के रूप में स्वीकार करते हैं जिन्हें CPF और CNPJ के लिए विराम चिह्न के साथ या बिना प्रदान किया जा सकता है CNH के लिए केवल 11 अंकों की संख्या बिना विराम चिह्न के स्वीकार की जाती है
डेटा की सटीकता CPF CNPJ और CNH के लिए वास्तविक चेक-डिजिट गणनाओं के माध्यम से बनाए रखी जाती है यह सुनिश्चित करता है कि प्रमाणीकरण प्रक्रिया ब्राजील में इन दस्तावेजों के लिए उपयोग किए जाने वाले आधिकारिक एल्गोरिदम का पालन करती है
सामान्य उपयोग के मामलों में व्यक्तियों या कंपनियों की पहचान सत्यापित करना नियामकों के साथ अनुपालन सुनिश्चित करना और उन लेनदेन में धोखाधड़ी रोकना शामिल है जिसमें प्रामाणिक ब्राजीलियाई दस्तावेजों की आवश्यकता होती है
उपयोगकर्ता दस्तावेज़ की मान्यता की पुष्टि के लिए `is_valid` फ़ील्ड की जाँच करकेreturned data का उपयोग कर सकते हैं `formatted_value` का उपयोग प्रदर्शन उद्देश्यों के लिए किया जा सकता है जबकि `input_value` रिकॉर्ड-कीपिंग या आगे की प्रक्रिया के लिए संग्रहीत किया जा सकता है