Índice

1. Objetivo
2. Histórico de versão
3. Regras de retorno
4. Endpoint da api

Consultar situação da solicitação

1. Objetivo

Permite consultar a situação do processamento da solicitação realizada por meio da API assíncrona

2. Histórico de versão

3. Regras de retorno

1. O endpoint retorna a situação atual da solicitação associada ao tiqueteSolicitacao.
2. Quando situacao=ERRO ou situacao=EXPIRADA, são retornados codigoErro e mensagemErro.

4. Endpoint da api

• URL de Produção:
  • https://api.receitafederal.gov.br/apuracao-cbs/v2/situacao/{tiqueteSolicitacao}

4.1 Campos de entrada

4.2 Header

4.3 Método e exemplo de requisição

Método: GET

curl --location --request GET 'https://api.receitafederal.gov.br/apuracao-cbs/v2/situacao/{tiqueteSolicitacao}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Exemplo com dados fictícios (Produção):

curl --location --request GET 'https://api.receitafederal.gov.br/apuracao-cbs/v2/situacao/{tiqueteSolicitacao}' \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.dadoFicticio.assinaturaFicticia' \
  --header 'Accept: application/json'

4.4 Campos retornados

4.5 Exemplos de retorno

Sucesso (HTTP 200):

{
  "situacao": "CONCLUIDA"
}

Solicitação expirada (HTTP 200):

{
  "situacao": "EXPIRADA",
  "codigoErro": "EXPIRADA",
  "mensagemErro": "Tempo limite de processamento excedido (240 minutos)."
}

Erro (HTTP 400/401/404/500):

{
  "situacao": "ERRO",
  "codigoErro": "ERRO_INTERNO",
  "mensagemErro": "Ocorreu um erro interno ao processar a solicitacao."
}