Data Provider - Serpro Overview
🔒 Digital identity verification in Brazil enhanced with Serpro's secure technology.
IDKit provides an integrated solution offering data validation provider Serpro, featuring two main API services Consulta CPF and Datavalid.
Note:
The CPF (Cadastro de Pessoas Físicas) is a national identification number issued to Brazilian citizens and residents for tax and other administrative functions.
When a customer completes the IDV flow (Normal V2) using their Brazilian CPF ID, IDKit sends several data points such as CPF, biographical and biometric data to the 2 APIs. CPF is a mandatory field if the user presents a Brazilian ID.
Info:
- Please contact your IDVerse representative if you require Serpro as a data verification service inside IDKit.
- Please refer to the API documentation for the IDKit Serpro Data Provider.
Serpro Consulta CPF API
- IDKit sends the CPF to Serpro’s CPF Consulta API service.
- IDKit retrieves the individual's registration status (e.g., regular, suspended, deceased) and biographical data (e.g., name, date of birth).
- Read detailed documentation from Serpro here.
The following are the field types returned, along with the corresponding situation codes and their descriptions.
| Field Types | Return Value |
|---|---|
NI "ni" | Registration Number in the Individual Taxpayer Register, in the format 99999999999. |
Name "nome" | Name of Individual. |
Situation "situacao" | Registration Status of Individuals, formed by two fields: Code and Description. |
Situation/Code "codigo" | Code of Registration Status of Individuals. |
Situation/Description "descricao" | Description of the Registration Status of Individuals. |
Date of Birth "nascimento" | Birthdate of Individuals, in the format DDMMYYYY. |
Year of Death "obito" | Death Year of Individuals, in the format YYYY. |
| Code | Description | Reason To Flag tx |
|---|---|---|
| 0 | Regular | pass |
| 2 | Suspended | flag |
| 3 | Deceased Holder | flag |
| 4 | Regularization Pending | flag |
| 5 | Canceled by Multiplicity | flag |
| 8 | Null | flag |
| 9 | Canceled Craft | flag |
Datavalid API
Biometric validation
- IDKit sends the CPF and face image to Serpro’s Datavalid API service.
- Serpro verifies that the CPF and face image match the information stored in the Brazilian government database for that CPF.
- IDKit retrieves results indicating whether the provided data exists (e.g., CPF true/false, name true/false) and assesses the similarity of the biometric data (e.g., probability: very low to very high, similarity: 1-100%).
- Read detailed documentation from Serpro here.
| Biometrical Fields | Return | Reason For Flag |
|---|---|---|
| Facial Biometrics | available: true/false (If false, flagged) probability: Very low, Low, High or Very high probability similarity: 0 to 1, where 1=100% | - If available = false - Probability = High or very high |
Info:
Biometric validation is only possible for individuals with a driver's license. However they can use other valid ID documents (e.g., passport, ID card) as long as they use their CPF and have a CNH (driver's license).
Biographical validation (coming soon in IDKit)
| Origin of the data | Biographical fields | Range | Return |
|---|---|---|---|
| RFB | cpf | cpf_disponivel: true/false | |
| RFB | cpf_situacao | regular suspended deceased holder pending settlement canceled by multiplicity null canceled ex officio | situacao_cpf: true/false |
| RFB | data_nascimento (date of birth) | data_nascimento: true/false | |
| RFB and Renach (driver's license) | nome (name) | nome: true/false nome_similaridade: from 0 to 1, where 1 = 100% | |
| Renach (driver's license) | sexo (gender) | F – feminino (female) M – masculino (male) O – outro (other) | sexo: true/false |
| Renach (driver's license) | nacionalidade (nationality) | 1 – brasileiro (Brazilian) 2 – brasileiro naturalizado (Brazilian naturalized citizen) 3 – estrangeiro (foreign) 4 – brasileiro nascido no exterior (Brazilian born abroad) | nacionalidade: true/false |
Example Results in IDKit
Note:
If the captured ID is non-Brazilian, the Serpro data check will not be invoked. The CPF number will not be displayed in the ID details screen for the customer during the flow. Lastly, the Serpro tab will not be available either in the repository or in the PDF.
Serpro - CPF Number captured under Documents
Serpro CPF Consulta only - Failed Result
In the following cases, only the Serpro CPF Consulta will be invoked, and Datavalid will not be invoked:
- If the Consulta CPF call returns an invalid CPF, the Datavalid API check is not invoked.
- If the user has configured the "Document Only" flow, i.e., the Normal V2 flow for which the Liveness Check is turned off, IDKit will only invoke the Serpro Consulta CPF API and not the Serpro Datavalid API.
Note:
The transaction above is flagged due to the situation code returned, which is 3, indicating a Deceased Holder.
Serpro - Consulta CPF and Datavalid API results captured under Data
Serpro Datavalid API was invoked because the Serpro Consulta CPF check passed.
However, in the screenshot below, Serpro Datavalid caused a flag of the transaction because no image is available in the government db for this user.
💬 We Are Here to Help!
If you encounter an issue, a bug, or require assistance, please contact our support page here to find the solution. Don't forget to provide any important information on the issue.
Updated 4 months ago