API Beneficiário Final, Endereço, Renda e Status da Receita

Esta API retorna os beneficiários finais associados a um CNPJ,
incluindo dados cadastrais, endereço residencial ou comercial, faixa
de renda estimada e status na Receita Federal de cada beneficiário
identificado.

TABELA DE CAMPOS DE REQUISIÇÃO

CampoDescriçãoFormatoObrigatório
IdConsultaIdentificador da consulta. Valor fixo: 635.stringSim
CpfCnpjCNPJ da empresa a ser consultada.stringSim

TABELA DE CAMPOS DE RETORNO

CampoDescriçãoFormato
CONSULTA.CODIGORESPOSTACódigo interno da transação.string
CONSULTA.DATAHORAData e hora da consulta.DD/MM/YYYY HH:MM:SS
CONSULTA.LOGONIdentificador da conta que realizou a consulta.string
CONSULTA.IDCONSULTAIdConsulta enviado na requisição.string
RESPOSTA.CODIGOCódigo do resultado: 1 sucesso, 2 não encontrado, 3 erro.string
RESPOSTA.BENEFICIARIO_FINAL.REGISTRO_N.CNPJCNPJ da empresa consultada.string
RESPOSTA.BENEFICIARIO_FINAL.REGISTRO_N.TIPO_DOCUMENTOTipo de documento do beneficiário (F = física, J = jurídica).string
RESPOSTA.BENEFICIARIO_FINAL.REGISTRO_N.RAZAO_SOCIALRazão social da empresa consultada.string
RESPOSTA.BENEFICIARIO_FINAL.REGISTRO_N.CPFCPF do beneficiário final.string
RESPOSTA.BENEFICIARIO_FINAL.REGISTRO_N.NOMENome completo do beneficiário final.string
RESPOSTA.BENEFICIARIO_FINAL.REGISTRO_N.TP_ENDERECOTipo de endereço (RESIDENCIAL ou COMERCIAL).string
RESPOSTA.BENEFICIARIO_FINAL.REGISTRO_N.TP_LOGRADOUROTipo de logradouro (ex: RUA, AV).string
RESPOSTA.BENEFICIARIO_FINAL.REGISTRO_N.LOGRADOURONome do logradouro.string
RESPOSTA.BENEFICIARIO_FINAL.REGISTRO_N.NUMERONúmero do endereço.string
RESPOSTA.BENEFICIARIO_FINAL.REGISTRO_N.COMPLEMENTOComplemento do endereço.string
RESPOSTA.BENEFICIARIO_FINAL.REGISTRO_N.BAIRROBairro do endereço.string
RESPOSTA.BENEFICIARIO_FINAL.REGISTRO_N.CIDADECidade do endereço.string
RESPOSTA.BENEFICIARIO_FINAL.REGISTRO_N.UFUF do endereço.string
RESPOSTA.BENEFICIARIO_FINAL.REGISTRO_N.CEPCEP do endereço.string
RESPOSTA.BENEFICIARIO_FINAL.REGISTRO_N.FAIXA_RENDA_ESTIMADAFaixa de renda estimada do beneficiário.string
RESPOSTA.BENEFICIARIO_FINAL.REGISTRO_N.STATUS_RECEITASituação cadastral do beneficiário na Receita Federal.string
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
Consulta
object
Responses

400

Bad Request

401

Unauthorized

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json