Faciledoc - API Docs
  1. SmartDoc
Faciledoc - API Docs
  • Apresentação
    • Autenticação
    • Verificar status da conta
      GET
  • V1
    • SmartDoc
      • Estrutura de respostas
      • CNPJ Verifica Situação
        GET
      • CNPJ Cadastral Básico
        GET
      • CNPJ Cadastral Completo
        GET
      • CPF Verifica Situação
        GET
      • CPF Cadastral
        GET
    • DataLens
      • Estrutura de respostas
      • CNPJ Cadastral
      • CNPJ Sintegra
      • CNPJ Sócios
      • CPF Cadastral
      • Buscar Análise
      • CNPJ Cadastral - Único CNPJ
      • CNPJ Sintegra - Único CNPJ
      • CNPJ Sócios - Único CNPJ
      • CPF Cadastral - Único CPF
  1. SmartDoc

Estrutura de respostas

Abaixo segue as estruturas de respostas que atendem todos os produtos SmartDoc:
400 - ERRO - Requisição solicitada com erro no campo obrigatório
{
    'api_versao': 'v1',
    'req_data': datetime,
    'req_status': 400,
    'req_msg': string, # mensagem referente a campo obrigatório
}
402 - ERRO - Requisição solicitada sem saldo suficiente
{
    'api_versao': 'v1',
    'req_data': datetime,
    'req_status': 402,
    'req_msg': string, # mensagem referente ao saldo insuficiente
}
403 - ERRO - Requisição solicitada sem permissão para consultar produto
{
    'api_versao': 'v1',
    'req_data': datetime,
    'req_status': 403,
    'req_msg': string, # mensagem referente à permissão de consulta ao produto
}
404 - ERRO - Requisição solicitada com erro em documento não encontrado
{
    'api_versao': 'v1',
    'req_data': datetime,
    'req_status': 404,
    'req_msg': string, # mensagem referente a documento não encontrado
}
200 - SUCESSO - Rota de busca do documento - Requisição realizada
{
    "api_versao": "v1",
    "req_data": datetime,
    "req_status": 200,
    "req_msg": "OK",
    "dados": {
        "produto": string, # Nome do produto consultado
        "res_smartdoc": {}, # Estrutura de resposta específica de cada produto SmartDoc
    }
}
Página anterior
SmartDoc
Próxima página
CNPJ Verifica Situação
Built with