Valida um CPF/CNPJ (dígitos verificadores) e, para um CNPJ, enriquece com o cadastro da empresa
/v1/utils/corporate-document-checkAutentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.
Parâmetros de consulta
documentstringobrigatórioO CPF ou CNPJ a conferir; a máscara é aceita.
Respostas
200Sucesso
cnaestringobrigatóriopode ser nuloCódigo da atividade principal (CNAE).
namestringobrigatóriopode ser nuloRazão social da empresa (só CNPJ).
sizestringobrigatóriopode ser nuloPorte da empresa (ex.:
ME,EPP).typestringobrigatóriopode ser nulocpfoucnpj;nullquando inválido.Valores:cpfcnpjemailstringobrigatóriopode ser nuloE-mail cadastrado (só CNPJ).
validbooleanobrigatórioSe o documento passa na validação dos dígitos verificadores.
activebooleanobrigatóriopode ser nuloSe a empresa está ativa na Receita.
addressobjectobrigatóriopode ser nuloEndereço cadastrado;
nullquando não disponível.+8 campos de
addresscitystringobrigatóriopode ser nuloCidade.
statestringobrigatóriopode ser nuloEstado (sigla de duas letras).
numberstringobrigatóriopode ser nuloNúmero.
streetstringobrigatóriopode ser nuloLogradouro.
countrystringobrigatórioCódigo do país.
districtstringobrigatóriopode ser nuloBairro.
postcodestringobrigatóriopode ser nuloCEP.
complementstringobrigatóriopode ser nuloComplemento.
documentstringobrigatórioO documento, só dígitos.
merchantobjectA conta dona do recurso (o vendedor de registro).
+3 campos de
merchantnamestringobrigatóriopode ser nuloNome fantasia da conta dona do recurso.
merchantIdstringobrigatóriopode ser nuloId público da conta dona do recurso (
bus_…).isSubAccountbooleanobrigatóriotruequando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.
partnersobject[]obrigatórioSócios da empresa.
+3 campos de
partnersnamestringobrigatóriopode ser nuloNome do sócio.
sincestringobrigatóriopode ser nuloDesde quando.
qualificationstringobrigatóriopode ser nuloQualificação do sócio.
meiOptantbooleanobrigatóriopode ser nuloSe é MEI.
telephonestringobrigatóriopode ser nuloTelefone cadastrado (só CNPJ).
fantasyNamestringobrigatóriopode ser nuloNome fantasia (só CNPJ).
legalNaturestringobrigatóriopode ser nuloNatureza jurídica da empresa.
openingDatestringobrigatóriopode ser nuloQuando a empresa foi aberta.
shareCapitalnumberobrigatóriopode ser nuloCapital social, em reais.
simplesOptantbooleanobrigatóriopode ser nuloSe é optante do Simples Nacional.
secondaryCnaesobject[]obrigatórioAtividades secundárias.
+2 campos de
secondaryCnaescodestringobrigatóriopode ser nuloCódigo da atividade.
descriptionstringobrigatóriopode ser nuloDescrição.
cnaeDescriptionstringobrigatóriopode ser nuloDescrição da atividade principal.
registrationStatusstringobrigatóriopode ser nuloSituação cadastral (ex.:
ATIVA).registrationStatusDatestringobrigatóriopode ser nuloQuando essa situação foi definida.
400Requisição inválida (validação)
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
401Não autenticado (credencial ausente ou inválida)
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
500Erro interno do servidor
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório