À propos de
API pour consulter le résumé d'enregistrement et les données CPF et CNPJ à la Receita Federal, sans avoir besoin de saisir une date de naissance ou des captchas. Avec un temps de réponse inférieur à 1 seconde, automatisez vos systèmes et augmentez l'intégrité de votre base de données avec des informations complètes et sécurisées.
Pour en savoir plus : www.cpfcnpj.com.br
Introduction
Este documento fornecerá instruções para rápida integração aos serviços da CPF.CNPJ via HTTP (HTTP API).
Qualquer linguagem de programação pode ser utilizada.
Attention !
Avant de procéder, il sera nécessaire d'avoir un enregistrement actif dans notre système.
Si ce n'est pas le cas, inscrivez-vous dès maintenant !
Règles d'utilisation
Afin de lutter contre tout type de bot qui pourrait nuire aux performances de l'API, nous avons défini des limites d'utilisation :
- 3 requêtes consécutives avec un jeton invalide : Blocage pendant 5 minutes ;
- 3 requêtes consécutives du même CPF/CNPJ dans le même paquet en moins d'une minute : Blocage pendant 3 minutes ;
- 3 requêtes consécutives sans crédit en moins d'une minute : Blocage pendant 5 minutes ;
URL de base
Les demandes GET sont effectuées sur une URL de base sous le protocole HTTPS.
URL : https://api.cpfcnpj.com.br/
Attention !
Toutes les demandes passent par CloudFlare avant d'atteindre nos serveurs.
Version minimale acceptable de TLS : 1.2
Pare-feu
Assurez-vous que vous accordez des autorisations sur votre pare-feu pour les IP de CloudFlare.
Accéder à la liste des IPs pour la libération : https://www.cloudflare.com/pt-br/ips/
Content-Type
Le retour des données de l'API se fera via JSON
.
application/json
.
Délai d'attente
Utilisez le délai d'attente par défaut de 60 secondes. Si vous utilisez une valeur inférieure, en cas d'instabilité de l'API, votre demande peut être interrompue avant de recevoir la réponse, consommant ainsi des crédits.
Actuellement, le délai moyen de traitement des requêtes est de 2 secondes.
Jetons
Pour effectuer des requêtes, il sera nécessaire d'enregistrer l'IP du serveur qui les effectuera. Pour ce faire, accédez à l'option API > Tokens dans votre Panneau de contrôle. Après l'enregistrement, votre jeton sera généré pour être inséré dans la base de données de l'UE. URL
de la demande.
Token pour les tests d'intégration :
Jeton : 5ae973d7a997af13f0aaf2bf60e65803
ATTENTION ! Ce jeton ne retournera que des données factices pour les tests d'intégration.
ID des paquets
Dans chaque demande, il faudra renseigner dans l'URL l'ID du paquet souhaité, ici nommé {pacote}
.
Pour contracter les paquets souhaités, accédez au Panneau de configuration. Consultez-les sur notre site web.
|
Pacote | Données retournées | Coût par consultation (BRL) |
---|---|---|---|
20 | CPF |
|
R$1,00 |
19 | CNPJ Lookalike |
|
R$0,24 |
1 | CPF A |
|
R$0,15 |
7 | CPF B |
|
R$0,22 |
2 | CPF C |
|
R$0,25 |
8 | CPF D |
|
R$0,36 |
9 | CPF E |
|
R$0,47 |
3 | CPF F |
Disponible uniquement sous contrat sur le plan post-payé. |
R$1,20 |
13 | CPF G |
Cliquez ici et lisez notre article pour plus d'informations. |
R$1,00 |
14 | CPF H |
Cliquez ici et lisez notre article pour plus d'informations. ¹ S'il ne s'agit pas d'un EPI, la déclaration sera |
R$0,20² |
15 | CPF I |
Liste des CNPJ dont le propriétaire est membre de l'entreprise. |
R$0,20 |
4 | CNPJ A |
|
R$0,13 |
5 | CNPJ B |
|
R$0,24 |
10 | CNPJ C |
|
R$0,32 |
6 | CNPJ D |
|
R$0,45 |
11 | CNPJ F |
|
R$0,30 |
12 | CNPJ G |
Cliquez ici et lisez notre article pour plus d'informations. |
R$1,00 |
16 | CNPJ H |
|
R$0,15 |
17 | CPF J |
|
R$0,18 |
18 | CPF K |
|
R$1,40 |
Demande de renseignements
En quelques étapes, nous allons expliquer comment la requête est effectuée par l'API CPF.CNPJ.
Après avoir généré le jeton, selon Introductionil sera nécessaire de construire l'URL de la demande.
Définition
qui contiendra le Token, ID de la Pacote et le numéro du CPF ou de la CNPJ à consulter, respectivement.
URL :https://api.cpfcnpj.com.br/{token}/{pacote}/{cpfcnpj}
Paramètres de la demande
Paramètre | Type | Description | Obligatoire ? |
---|---|---|---|
jeton | chaîne de caractères | Token généré dans le panneau de contrôle. | |
pacote | int | ID du paquet à utiliser, selon le tableau. | |
cpfcnpj | chaîne de caractères | Numéro CPF à 11 chiffres ou CNPJ à 14 chiffres. |
Exemples d'URL :
Consulter le CPF dans le paquet CPF E: https://api.cpfcnpj.com.br/5ae973d7a997af13f0aaf2bf60e65803/9/00000000000
Consulter la CNPJ dans le paquet CNPJ D: https://api.cpfcnpj.com.br/5ae973d7a997af13f0aaf2bf60e65803/6/27272134000118/0
Attention !
Informer /0
à la fin de l'URL des paquets CPF F, CNPJ B, C et D, l'API pas recherchera l'adresse (rue, quartier, ville et état) dans la base de données de l'API Brasil (brasilapi.com.br), réduisant le temps de réponse de 0,8 seconde en moyenne.
Paramètres de réponse
Vérifiez ci-dessous les champs retournés pour les CPF et CNPJ.
Chaque paquet de requêtes a ses paramètres de réponse respectifs. Il faut donc s'intégrer en conséquence.
Réponses CPF
Matrice de réponse principale qui varie selon le paquet :
Paramètre | Type | Description |
---|---|---|
statut | bool | 1 pour le succès de la demande et 0 pour l'échec de la demande. S'il retourne 0 consulter le tableau des erreurs. |
cpf | chaîne de caractères | Numéro CPF formaté interrogé avec 14 chiffres. |
nome | chaîne de caractères | Nom complet du titulaire (sans accents). |
nascimento | chaîne de caractères | Date de naissance du titulaire en JJ/MM/AAAA. |
mae | chaîne de caractères | Nom complet de la mère du titulaire (sans accents). |
genero | chaîne de caractères | M pour les hommes ;F pour les femmes. |
situacao | chaîne de caractères | Statut d'enregistrement auprès de l'administration fiscale fédérale :Regular , Cancelada , Suspensa , Pendente ou Nula |
risco | risco[] | Matrice d'objets contenant le niveau de probabilité de défaut futur, selon SERASA. Cliquez ici pour en savoir plus. |
endereco | chaîne de caractères | Adresse du domicile du titulaire. |
numero | chaîne de caractères | Numéro dans l'adresse. |
complemento | chaîne de caractères | Complément d'adresse. |
bairro | chaîne de caractères | Adresse du quartier. |
cep | chaîne de caractères | Adresse code postal. |
cidade | chaîne de caractères | Ville de l'adresse. |
uf | chaîne de caractères | Fédération Unité de l'adresse avec 2 lettres. |
ppe | ppe[] | Matrice contenant la liste des positions possibles de la Personne Politiquement Exposée du CPF consulté dans le paquet CPF H. S'il ne s'agit pas d'un CPF, la matrice sera vide. |
pacoteUsado | int | ID du paquet utilisé. |
saldo | int | Solde du paquet utilisé après consultation. |
consultaID | chaîne de caractères | ID de requête à 16 chiffres. |
delay | float | Temps nécessaire pour effectuer la requête en secondes. |
Matrice EPP
Matrice ppe[]
contenant une liste de postes PPE possibles :
Paramètre | Type | Description |
---|---|---|
sigla | chaîne de caractères | Acronyme de la fonction du poste politique |
funcao | chaîne de caractères | Fonction du bureau politique |
nivel | chaîne de caractères | Niveau de la hiérarchie politique |
orgao | chaîne de caractères | Organisme politiquement actif |
inicioexercicio | chaîne de caractères | Date de début de l'emploi au format DD/MM/YYYY |
fimexercicio | chaîne de caractères | Date de fin de travail au format DD/MM/YYYY |
fimcarencia | chaîne de caractères | Date de fin de mandat dans le format DD/MM/YYYY |
Réponses de la CNPJ
Matrice de réponse principale qui varie selon le paquet :
Paramètre | Type | Description |
---|---|---|
statut | bool | 1 pour le succès de la demande et 0 pour l'échec de la demande. S'il retourne 0 consulter le tableau des erreurs. |
cnpj | chaîne de caractères | Numéro formaté du CNPJ interrogé avec 18 chiffres. |
razao | chaîne de caractères | Nom de la société. |
fantasia | chaîne de caractères | Nom commercial de l'entreprise. |
inicioAtividade | chaîne de caractères | Date de début des activités au format JJ/MM/AAAA. |
chaîne de caractères | Adresse électronique dans le registre de l'entreprise. | |
responsavel | chaîne de caractères | Nom de la personne légalement responsable de l'entreprise (sans accents). |
simplesNacional | simplesNacional[] | Matrice contenant les informations possibles de Simples Nacional. |
simei | simei[] | Matrice contenant les informations possibles du SIMEI. |
matrizEndereco | matrizEndereco[] | Matrice d'objets d'adresses. |
matrizfilial | matrizfilial[] | Matrice d'objets de l'organisme compétent. |
telefones | telefones[] | Matrice d'objets contenant le(s) numéro(s) de téléphone de l'entreprise. Un maximum de 2 numéros de téléphone. |
fax | fax[] | Matrice d'objets contenant le(s) fax de l'entreprise. |
situacao | situacao[] | Matrice d'objets contenant les données du statut d'enregistrement de l'entreprise auprès de l'administration fiscale fédérale. |
naturezaJuridica | naturezaJuridica[] | Matrice d'objets contenant des données sur la nature juridique. |
cnae | cnae[] | Matrice d'objets contenant les données du CNAE principal. |
porte | porte[] | Matrice d'objets contenant des données sur la taille des entreprises. |
socios | socios[] | Matrice d'objets contenant les données du ou des membres, QSA. |
risco | risco[] | Matrice d'objets contenant le niveau de probabilité de défaut futur, selon SERASA. Cliquez ici pour en savoir plus. |
pacoteUsado | int | ID du paquet utilisé. |
saldo | int | Solde du paquet utilisé après consultation. |
consultaID | chaîne de caractères | ID de requête à 16 chiffres. |
retarder | float | Temps nécessaire pour effectuer la requête en secondes. |
Matriz simplesNacional
Matrice simplesNacional[]
contenant des informations sur la possibilité d'opter pour le Simples Nacional :
Paramètre | Type | Description |
---|---|---|
optante | chaîne de caractères | Sim ou Não actuellement. |
inicio | chaîne de caractères | Date d'entrée en fonction de Simples Nacional au format DD/MM/YYYY |
fim | chaîne de caractères | Date de fin comme Simples Nacional dans le format DD/MM/YYYY |
Matriz simei
Matrice simei[]
contenant des informations sur les éventuels optants du SIMEI :
Paramètre | Type | Description |
---|---|---|
optante | chaîne de caractères | Sim ou Não actuellement. |
anteriores | matrice | Matrice anteriores[] contenant la liste des enregistrements précédents en tant que SEMEI. |
Matriz anteriores
Matrice anteriores[]
contenant la liste des enregistrements précédents en tant que SEMEI :
Paramètre | Type | Description |
---|---|---|
inicio | chaîne de caractères | Date d'entrée en fonction comme SIMEI dans le format DD/MM/YYYY |
fim | chaîne de caractères | Date de fin en tant que SIMEI dans le format DD/MM/YYYY |
detalhamento | chaîne de caractères | Description du registre |
Matriz matrizEndereco
Matrice matrizEndereco[]
contenant des informations sur l'adresse :
Paramètre | Type | Description |
---|---|---|
cep | chaîne de caractères | Code postal de l'adresse à 9 chiffres. |
tipo | chaîne de caractères | Type d'adresse, qui peut être :Aeroporto , Avenida , Caminho , Colonia , Esplanada , Estrada , Fazenda , Ladeira , Lago , Loteamento , Nao Informado , Passarela , Quadra , Recanto , Rua , Sitio , Vale , Vereda , Via |
logradouro | chaîne de caractères | Adresse de la société. |
numero | string | Numéro dans l'adresse de l'entreprise. |
complemento | chaîne de caractères | Complément d'adresse. |
bairro | chaîne de caractères | Adresse du quartier. |
cidade | chaîne de caractères | Ville de l'adresse. |
uf | chaîne de caractères | Fédération Unité de l'adresse avec 2 lettres. |
Matriz matrizfilial
Matrice matrizfilial[]
contenant des informations sur l'organisme compétent, à savoir ID et Type respectivement :
Paramètre | Type | Description |
---|---|---|
id | int | ID du corps |
tipo | chaîne de caractères | Corps : id 1 : Matriz id 2 : Filial |
Matriz telefones
Matrice telefones[]
contenant au moins un numéro de téléphone d'entreprise :
Paramètre | Type | Description |
---|---|---|
ddd | chaîne de caractères | Indicatif téléphonique |
numero | chaîne de caractères | Numéro de téléphone |
Matriz fax
Matrice fax[]
contenant les éventuels numéros de fax des entreprises :
Paramètre | Type | Description |
---|---|---|
ddd | chaîne de caractères | Indicatif régional du fax |
numero | chaîne de caractères | Numéro de fax |
Matriz situacao
Matrice situacao[]
contenant des données sur le statut d'enregistrement de l'entreprise auprès de l'administration fiscale fédérale :
Paramètre | Type | Description |
---|---|---|
id | int | Identification de la situation cadastrale. |
nome | chaîne de caractères | Nom de l'état cadastral, soit : id 1 : Baixada id 2 : Ativa id 3 : Suspensa id 4 : Inapta id 8 : Baixada |
data | chaîne de caractères | Date du statut cadastral dans le format DD/MM/YYYY . |
Matriz naturezaJuridica
Matrice naturezaJuridica[]
contenant des données sur la nature juridique.
Cliquez sur ICI pour accéder à la liste officielle des codes et des descriptions.
Paramètre | Type | Description |
---|---|---|
codigo | chaîne de caractères | Code de nature juridique à 4 chiffres sans trait d'union. |
descricao | chaîne de caractères | Description de la nature juridique. |
Matriz cnae
Matrice cnae[]
contenant des données sur le principal CNAE de l'entreprise.
Cliquez sur ICI pour accéder au tableau des codes et des descriptions.
Paramètre | Type | Description |
---|---|---|
divisao | chaîne de caractères | Code de la division. |
grupo | chaîne de caractères | Code du groupe. |
classe | chaîne de caractères | Code de classe. |
subClasse | chaîne de caractères | Code de sous-classe. |
fiscal | chaîne de caractères | Code CNAE complet, chiffres uniquement. |
descricao | chaîne de caractères | Description de la CNAE. |
Matriz porte
Matrice porte[]
contenant des données sur la taille de l'entreprise.
Paramètre | Type | Description |
---|---|---|
id | chaîne de caractères | ID du port. |
descricao | chaîne de caractères | Description de la taille de l'entreprise, soit : id 0 : Demais id 1 : Matriz id 3 : Demais id 5 : Demais |
Matriz socios
Matrice socios[]
contenant les données du QSA de l'entreprise.
Paramètre | Type | Description |
---|---|---|
nome | chaîne de caractères | Nom du partenaire PF ou PJ (sans accentuation). |
cnpj | chaîne de caractères | Numéro CNPJ formaté dans le cas où vous êtes un partenaire PJ. |
tipo | chaîne de caractères | Type de membre. |
capitalSocial | float | Pourcentage du capital social de l'associé dans la société. |
pais | chaîne de caractères | Le pays d'origine du partenaire. |
Matriz risco
Matrice risco[]
contenant des informations sur les scores dans SERASA.
Paramètre | Type | Description |
---|---|---|
nivel | int | ID du niveau. |
descricao | chaîne de caractères | Description du niveau de risque, étant : niveau 0 : Inconnu niveau 1 : Basse niveau 2 : Moyen niveau 3 : Haut niveau 4 : Le plus haut |
score | chaîne de caractères |
Niveau de score Fourchette de score.
CPF :
CNPJ : |
Soldes de chèques
Vérifiez gratuitement le solde du forfait souhaité.
Définition
qui contiendra le Token et l'ID de la Paquet à consulter, respectivement.
URL :https://api.cpfcnpj.com.br/{token}/saldo/{pacote}
Paramètres de la demande
Paramètre | Type | Description | Obligatoire ? |
---|---|---|---|
jeton | chaîne de caractères | Token généré dans le panneau de contrôle. | |
pacote | int | ID du paquet à utiliser, selon le tableau. |
Paramètres de réponse
Matrice pacote[]
contenant des informations sur le solde du paquet.
Paramètre | Type | Description |
---|---|---|
id | int | ID du paquet. |
nome | chaîne de caractères | Nom du paquet consulté. |
saldo | int | Solde du paquet consulté. |
Codes d'erreur
Vérifiez ci-dessous tous les types d'erreurs retournés dans le paramètre erreur
e errorCode
:
erroCodigo |
Valeur | erreur |
Description |
---|---|---|---|
|
CPF | CPF inválido! | Le numéro saisi n'est pas un CPF valide. |
|
CPF | Informe um CPF com 11 dígitos! | Le CPF informé comporte moins de 11 chiffres. |
|
CPF | O CPF informado não existe nas bases de dados da Receita Federal! Por favor, confira o número do CPF e tente novamente. | Le CPF est valable, mais n'appartient à personne. Dans certains cas, le CPF est valide, existe dans la Receita Federal, mais ne s'est pas encore propagé dans l'API selon le délai stipulé dans les conditions d'utilisation. |
|
CNPJ | CNPJ inválido! | Le numéro saisi n'est pas un CNPJ valide. |
|
CNPJ | Informe um CNPJ com 14 dígitos! | Le CNPJ informé a moins de 14 chiffres. |
|
CNPJ | O CNPJ informado não existe nas bases de dados da Receita Federal! Por favor, confira o número do CNPJ e tente novamente. | Le CNPJ est valide, mais n'appartient à aucune entreprise. Dans certains cas, la CNPJ est valide, existe dans la Receita Federal, mais ne s'est pas encore propagée dans l'API comme le stipulent les conditions d'utilisation. |
|
CPF/CNPJ | Token inválido! (...) | Le jeton renseigné n'appartient pas à l'IP qui effectue la requête. |
|
CPF/CNPJ | Créditos insuficientes! | Vous n'avez pas de crédits dans le paquet informé, pour effectuer des consultations. |
|
CPF/CNPJ | Conta suspensa e/ou inativa! | Veuillez nous contacter pour en vérifier la raison. |
|
CPF/CNPJ | Blacklist até *DATA* | IP et Token temporairement suspendus pour avoir enfreint l'une des règles d'utilisation. |
|
CPF/CNPJ | Pacote indisponível para consultas! | L'ID du paquet saisi n'est pas valide ou n'est pas disponible pour les requêtes. |
|
CPF/CNPJ | Não é possível consultar *CPF/CNPJ* neste pacote! | Échec du traitement de la demande avec le fournisseur ou erreur interne. Vérifiez auprès du service d'assistance. |
|
CPF/CNPJ | Supplier 2 offline. Contact us! | Le fournisseur de données est hors ligne ou connaît des instabilités. Veuillez réessayer ou nous contacter. |
|
CPF/CNPJ | Limite de requisições (20) por segundo excedido. Por favor, tente novamente. | Limite maximale de 20 requêtes par seconde. |