Respostas

Todas as respostas enviadas pelo serviço são encapsuladas em um envelope com a situação do enriquecimento, definida no campo status.

​

Em execução

Ao receber uma solicitação, o serviço inicia automaticamente a execução do enriquecimento com o status RUNNING. Geralmente, esta é a resposta que o cliente recebe ao iniciar um enriquecimento.

{
  "status": "RUNNING"
}

​

Sucesso

Em segundo plano, o Searching iniciará o processo de enriquecimento de dados.

Quando a execução do enriquecimento é finalizada, seu estado é alterado para COMPLETED. Nesta situação, um atributo data que contém o resultado do enriquecimento é adicionado ao corpo da resposta.

{
  "status": "COMPLETED",
  "data": {
    "id": "21.593.012/0001-47",
    "trade_name": "Exact Sales",
    "site": "https://exactsales.com.br"
    // ...
  }
}

Quando um enriquecimento é executado com sucesso, seu resultado é armazenado em cache por 30 dias. Deste modo, solicitações subsequentes com os mesmos parâmetros sempre retornam os mesmos dados.

​

Falha

Enriquecimentos também podem falhar devido a situações inesperadas. Isso significa que o serviço não encontrou dados suficientes para fornecer uma saída confiável.

Exemplo: enviar um CNPJ inexistente para o método de enriquecimento de empresas resulta em falha.

{
  "status": "FAILED"
}