Acerca de
API para consultar el resumen de registro y los datos del CPF y CNPJ en la Receita Federal, sin necesidad de introducir la fecha de nacimiento o captchas. Con un tiempo de respuesta inferior a 1 segundo, automatice los sistemas y aumente la integridad de su base de datos con información completa y segura.
Más información en: www.cpfcnpj.com.br
Introducción
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.
¡Atención!
Antes de proceder, será necesario tener un registro activo en nuestro sistema.
Si no es así, ¡inscríbase ahora!
Normas de uso
Para que podamos combatir cualquier tipo de bot que pueda perjudicar el rendimiento de la API, hemos definido limitaciones de uso:
- 3 consultas consecutivas con token no válido: Bloqueo durante 5 minutos;
- 3 consultas consecutivas del mismo CPF/CNPJ en el mismo paquete en menos de 1 minuto: Bloqueo durante 3 minutos;
- 3 consultas consecutivas sin crédito en menos de 1 minuto: Bloqueo durante 5 minutos;
URL base
Las solicitudes GET se realizan sobre una URL base bajo el protocolo HTTPS.
URL: https://api.cpfcnpj.com.br/
¡Atención!
Todas las peticiones pasan por CloudFlare antes de llegar a nuestros servidores.
Versión mínima aceptable de TLS: 1.2
Cortafuegos
Asegúrese de conceder permisos en su firewall para las IPs de CloudFlare.
Acceda a la lista de IPs para la liberación: https://www.cloudflare.com/pt-br/ips/
Tipo de contenido
La devolución de datos de la API se hará a través de JSON
.
aplicación/json
.
Tiempo de espera
Utilice el tiempo de espera predeterminado de 60 segundos. Si utiliza un valor inferior, en caso de inestabilidad de la API, su solicitud puede ser abortada antes de recibir la respuesta, consumiendo créditos.
Actualmente, el tiempo medio de respuesta a las consultas es de 2 segundos.
Fichas
Para realizar consultas, será necesario registrar la IP del servidor que las realizará. Para ello, acceda a la opción API > Tokens en su Panel de control. Tras el registro, se generará un token que se insertará en el URL
de la solicitud.
Ficha para las pruebas de integración:
Ficha: 5ae973d7a997af13f0aaf2bf60e65803
ATENCIÓN: Este token sólo devolverá datos ficticios para las pruebas de integración.
ID de los paquetes
En cada solicitud, será necesario informar en la URL el ID del paquete deseado, aquí denominado {pacote}
.
Para contratar los paquetes deseados, acceda al Panel de Control. Consúltelos en nuestro sitio web.
|
Pacote | Datos devueltos | Coste por consulta (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 |
Sólo disponible bajo contrato en el plan de pospago. |
R$1,20 |
13 | CPF G |
Haga clic aquí y lea nuestro artículo para obtener más información. |
R$1,00 |
14 | CPF H |
Haga clic aquí y lea nuestro artículo para obtener más información. ¹ Si no es un EPI, la devolución será |
R$0,20² |
15 | CPF I |
Lista de CNPJ en los que el titular es miembro de la empresa. |
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 |
Haga clic aquí y lea nuestro artículo para obtener más información. |
R$1,00 |
16 | CNPJ H |
|
R$0,15 |
17 | CPF J |
|
R$0,18 |
18 | CPF K |
|
R$1,40 |
Hacer consultas
En unos pocos pasos, explicaremos cómo se realiza la consulta mediante la API CPF.CNPJ.
Después de generar el token, según Introducciónserá necesario construir la URL de la solicitud.
Definición
Endpoint que contendrá el TokenID de la Pacote y número del CPF o del CNPJ a consultar, respectivamente.
URL:https://api.cpfcnpj.com.br/{token}/{pacote}/{cpfcnpj}
Parámetros de solicitud
Parámetro | Tipo | Descripción | ¿Obligatorio? |
---|---|---|---|
ficha | cadena | Token generado en el Panel de Control. | |
pacote | int | ID del paquete a utilizar, según la tabla. | |
cpfcnpj | cadena | Número CPF con 11 dígitos o CNPJ con 14 dígitos. |
Ejemplos de URL:
Consulte el CPF en el paquete CPF E: https://api.cpfcnpj.com.br/5ae973d7a997af13f0aaf2bf60e65803/9/00000000000
Consulte el CNPJ en el paquete CNPJ D: https://api.cpfcnpj.com.br/5ae973d7a997af13f0aaf2bf60e65803/6/27272134000118/0
¡Atención!
Informar a /0
al final de la URL de los paquetes CPF F, CNPJ B, C y D, la API no buscará la dirección (calle, barrio, ciudad y estado) en la base de datos de la API de Brasil (brasilapi.com.br), reduciendo el tiempo de respuesta en una media de 0,8 segundos.
Parámetros de respuesta
Compruebe a continuación los campos devueltos para los CPF y los CNPJ.
Cada paquete de consulta tiene sus respectivos parámetros de respuesta. Por lo tanto, intégrese en consecuencia.
Respuestas del CPF
Matriz de respuesta principal que varía según el paquete:
Parámetro | Tipo | Descripción |
---|---|---|
estado | bool | 1 para el éxito en la solicitud y 0 por el fracaso de la solicitud. Si devuelve 0 consultar el tabla de errores. |
cpf | cadena | Número CPF formateado consultado con 14 dígitos. |
nome | cadena | Nombre completo del titular (sin acentos). |
nascimento | cadena | Fecha de nacimiento del titular en DD/MM/AAAA. |
mae | cadena | Nombre completo de la madre del titular (sin acentos). |
genero | cadena | M para el Hombre;F para la mujer. |
situacao | cadena | Situación de registro en la Hacienda Federal:Regular , Cancelada , Suspensa , Pendente o Nula |
risco | risco[] | Matriz de objetos que contiene el nivel de probabilidad de impago futuro, según SERASA. Haga clic aquí y obtenga más información. |
endereco | cadena | Dirección del titular. |
numero | cadena | Número en la dirección. |
complemento | cadena | Complemento de dirección. |
bairro | cadena | Dirección del barrio. |
cep | cadena | Código postal de la dirección. |
cidade | cadena | Ciudad de la dirección. |
uf | cadena | Unidad de la Federación de la dirección con 2 letras. |
ppe | ppe[] | Matriz que contiene la lista de posibles cargos de la Persona Políticamente Expuesta del CPF consultado en el paquete CPF H. Si no es un CPF, la matriz estará vacía. |
pacoteUsado | int | ID del paquete utilizado. |
saldo | int | Saldo del paquete utilizado tras la consulta. |
consultaID | cadena | ID de consulta con 16 dígitos. |
delay | float | Tiempo que se tarda en realizar la consulta en segundos. |
Matriz del PPE
Matriz ppe[]
que contiene una lista de posibles puestos del PPE:
Parámetro | Tipo | Descripción |
---|---|---|
sigla | cadena | Acrónimo de la función del puesto político |
funcao | cadena | Función del cargo político |
nivel | cadena | Nivel de jerarquía política |
orgao | cadena | Organismo políticamente activo |
inicioexercicio | cadena | Fecha de inicio del trabajo en formato DD/MM/AAAA |
fimexercicio | cadena | Fecha de finalización del trabajo en formato DD/MM/AAAA |
fimcarencia | cadena | Fecha de finalización del mandato en el formato DD/MM/AAAA |
Respuestas del CNPJ
Matriz de respuesta principal que varía según el paquete:
Parámetro | Tipo | Descripción |
---|---|---|
estado | bool | 1 para el éxito en la solicitud y 0 por el fracaso de la solicitud. Si devuelve 0 consultar el tabla de errores. |
cnpj | cadena | Número formateado del CNPJ consultado con 18 dígitos. |
razao | cadena | Nombre de la empresa. |
fantasia | cadena | Nombre comercial de la empresa. |
inicioAtividade | cadena | Fecha de inicio de las actividades en formato DD/MM/AAAA. |
cadena | Dirección de correo electrónico en el registro de la empresa. | |
responsavel | cadena | Nombre de la persona legalmente responsable de la empresa (sin acentos). |
simplesNacional | simplesNacional[] | Matriz con posible información de Simples Nacional. |
simei | simei[] | Matriz que contiene la posible información del SIMEI. |
matrizEndereco | matrizEndereco[] | Matriz de objetos de dirección. |
matrizfilial | matrizfilial[] | Matriz de objetos del organismo competente. |
telefones | telefones[] | Matriz de objetos que contiene los números de teléfono de la empresa. Un máximo de 2 números de teléfono. |
fax | fax[] | Matriz de objetos que contiene el(los) fax(es) de la empresa. |
situacao | situacao[] | Matriz de objetos que contiene los datos de la situación de registro de la empresa en la Hacienda Federal. |
naturezaJuridica | naturezaJuridica[] | Matriz de objetos que contiene datos de naturaleza jurídica. |
cnae | cnae[] | Matriz de objetos que contienen datos del CNAE principal. |
porte | porte[] | Matriz de objetos que contiene los datos del tamaño de la empresa. |
socios | socios[] | Matriz de objetos que contiene los datos de los miembros, QSA. |
risco | risco[] | Matriz de objetos que contiene el nivel de probabilidad de impago futuro, según SERASA. Haga clic aquí y obtenga más información. |
pacoteUsado | int | ID del paquete utilizado. |
saldo | int | Saldo del paquete utilizado tras la consulta. |
consultaID | cadena | ID de consulta con 16 dígitos. |
retraso | float | Tiempo que se tarda en realizar la consulta en segundos. |
Matriz simplesNacional
Matriz simplesNacional[]
con información sobre la posibilidad de optar al Simples Nacional:
Parámetro | Tipo | Descripción |
---|---|---|
optante | cadena | Sim o Não actualmente. |
inicio | cadena | Fecha de inicio como Simples Nacional en el formato DD/MM/AAAA |
fim | cadena | Fecha de finalización como Simples Nacional en el formato DD/MM/AAAA |
Matriz simei
Matriz simei[]
que contiene información sobre los posibles optantes del SIMEI:
Parámetro | Tipo | Descripción |
---|---|---|
optante | cadena | Sim o Não actualmente. |
anteriores | matriz | Matriz anteriores[] que contiene la lista de inscripciones anteriores como SEMEI. |
Matriz anteriores
Matriz anteriores[]
que contiene la lista de inscripciones anteriores como SEMEI:
Parámetro | Tipo | Descripción |
---|---|---|
inicio | cadena | Fecha de inicio como SIMEI en el formato DD/MM/AAAA |
fim | cadena | Fecha de finalización como SIMEI en el formato DD/MM/AAAA |
detalhamento | cadena | Descripción del registro |
Matriz matrizEndereco
Matriz matrizEndereco[]
que contiene información sobre la dirección:
Parámetro | Tipo | Descripción |
---|---|---|
cep | cadena | Código postal de la dirección con 9 dígitos. |
tipo | cadena | Tipo de dirección, que puede ser:Aeroporto , Avenida , Caminho , Colonia , Esplanada , Estrada , Fazenda , Ladeira , Lago , Loteamento , Nao Informado , Passarela , Quadra , Recanto , Rua , Sitio , Vale , Vereda , Via |
logradouro | cadena | Dirección de la empresa. |
numero | string | Número en la dirección de la empresa. |
complemento | cadena | Complemento de dirección. |
bairro | cadena | Dirección del barrio. |
cidade | cadena | Ciudad de la dirección. |
uf | cadena | Unidad de la Federación de la dirección con 2 letras. |
Matriz matrizfilial
Matriz matrizfilial[]
que contienen información sobre el organismo competente siendo ID y Tipo respectivamente:
Parámetro | Tipo | Descripción |
---|---|---|
id | int | Identificación del cuerpo |
tipo | cadena | Cuerpo: id 1 : Matriz id 2 : Filial |
Matriz telefones
Matriz telefones[]
que contenga al menos un número de teléfono de la empresa:
Parámetro | Tipo | Descripción |
---|---|---|
ddd | cadena | Código de área del teléfono |
numero | cadena | Número de teléfono |
Matriz fax
Matriz fax[]
con posibles números de fax de la empresa:
Parámetro | Tipo | Descripción |
---|---|---|
ddd | cadena | Código de área del fax |
numero | cadena | Número de fax |
Matriz situacao
Matriz situacao[]
que contiene datos sobre la situación de registro de la empresa en la Hacienda Federal:
Parámetro | Tipo | Descripción |
---|---|---|
id | int | Identificación de la situación catastral. |
nome | cadena | Nombre del estado catastral, siendo: id 1 : Baixada id 2 : Ativa id 3 : Suspensa id 4 : Inapta id 8 : Baixada |
data | cadena | Fecha del estado catastral en el formato DD/MM/AAAA . |
Matriz naturezaJuridica
Matriz naturezaJuridica[]
que contiene datos sobre la naturaleza jurídica.
Haga clic en AQUÍ para acceder a la lista oficial de códigos y descripciones.
Parámetro | Tipo | Descripción |
---|---|---|
codigo | cadena | Código de la naturaleza jurídica con 4 dígitos sin guión. |
descricao | cadena | Descripción de la naturaleza jurídica. |
Matriz cnae
Matriz cnae[]
que contiene datos sobre la principal CNAE de la empresa.
Haga clic en AQUÍ para acceder a la tabla de códigos y descripciones.
Parámetro | Tipo | Descripción |
---|---|---|
divisao | cadena | Código de la división. |
grupo | cadena | Código de grupo. |
classe | cadena | Código de clase. |
subClasse | cadena | Código de subclase. |
fiscal | cadena | Código CNAE completo, sólo números. |
descricao | cadena | Descripción del CNAE. |
Matriz porte
Matriz porte[]
que contiene datos sobre el tamaño de la empresa.
Parámetro | Tipo | Descripción |
---|---|---|
id | cadena | Identificación del puerto. |
descricao | cadena | Descripción del tamaño de la empresa, siendo: id 0 : Demais id 1 : Matriz id 3 : Demais id 5 : Demais |
Matriz socios
Matriz socios[]
que contiene datos de la QSA de la empresa.
Parámetro | Tipo | Descripción |
---|---|---|
nome | cadena | Nombre del socio FP o PJ (sin acentuar). |
cnpj | cadena | Número de CNPJ formateado en caso de ser socio de PJ. |
tipo | cadena | Tipo de miembro. |
capitalSocial | float | Porcentaje de capital social del socio en la empresa. |
pais | cadena | País de origen del socio. |
Matriz risco
Matriz risco[]
que contiene información de puntuación en SERASA.
Parámetro | Tipo | Descripción |
---|---|---|
nivel | int | Identificación del nivel. |
descricao | cadena | Descripción del nivel de riesgo, siendo: nivel 0 : Desconocido nivel 1 : Bajo nivel 2 : Medio nivel 3 : Alta nivel 4 : El más alto |
score | cadena |
Nivel de puntuación Rango de puntuación.
CPF:
CNPJ: |
Comprobación de saldos
Sin coste alguno, compruebe el saldo del paquete deseado.
Definición
Endpoint que contendrá el Token y el ID del Paquete a consultar, respectivamente.
URL:https://api.cpfcnpj.com.br/{token}/saldo/{pacote}
Parámetros de solicitud
Parámetro | Tipo | Descripción | ¿Obligatorio? |
---|---|---|---|
ficha | cadena | Token generado en el Panel de Control. | |
pacote | int | ID del paquete a utilizar, según la tabla. |
Parámetros de respuesta
Matriz pacote[]
que contiene la información de balance del paquete.
Parámetro | Tipo | Descripción |
---|---|---|
id | int | Identificación del paquete. |
nome | cadena | Nombre del paquete consultado. |
saldo | int | Saldo del paquete consultado. |
Códigos de error
Compruebe a continuación todos los tipos de errores devueltos en el parámetro error
e errorCode
:
erroCodigo |
Valor | error |
Descripción |
---|---|---|---|
|
CPF | CPF inválido! | El número introducido no es un CPF válido. |
|
CPF | Informe um CPF com 11 dígitos! | El CPF informado tiene menos de 11 dígitos. |
|
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. | El CPF es válido, pero no pertenece a ninguna persona. En algunos casos, el CPF es válido, existe en la Receita Federal, pero aún no se ha propagado en la API según el plazo estipulado en las condiciones de uso. |
|
CNPJ | CNPJ inválido! | El número introducido no es un CNPJ válido. |
|
CNPJ | Informe um CNPJ com 14 dígitos! | El CNPJ informado tiene menos de 14 dígitos. |
|
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. | El CNPJ es válido, pero no pertenece a ninguna empresa. En algunos casos, el CNPJ es válido, existe en la Receita Federal, pero aún no se ha propagado en la API como se estipula en las condiciones de uso. |
|
CPF/CNPJ | Token inválido! (...) | El token informado no pertenece a la IP que realiza la consulta. |
|
CPF/CNPJ | Créditos insuficientes! | No tiene créditos en el paquete informado, para realizar consultas. |
|
CPF/CNPJ | Conta suspensa e/ou inativa! | Póngase en contacto con nosotros para comprobar el motivo. |
|
CPF/CNPJ | Blacklist até *DATA* | IP y Token suspendidos temporalmente por infringir una de las Normas de Uso. |
|
CPF/CNPJ | Pacote indisponível para consultas! | El ID del paquete introducido no es válido o no está disponible para las consultas. |
|
CPF/CNPJ | Não é possível consultar *CPF/CNPJ* neste pacote! | No se ha podido procesar la solicitud con el proveedor o con un error interno. Consulta con el servicio de asistencia técnica. |
|
CPF/CNPJ | Supplier 2 offline. Contact us! | Proveedor de datos fuera de línea o con inestabilidad. Por favor, inténtelo de nuevo o póngase en contacto con nosotros. |
|
CPF/CNPJ | Limite de requisições (20) por segundo excedido. Por favor, tente novamente. | Límite máximo de 20 consultas por segundo. |