Índice
- Objetivo
- Histórico de versão
- Regras de retorno
- 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
| Data | Versão | Descrição |
|---|---|---|
| 03/09/2026 | 1.0 | Versão inicial |
3. Regras de retorno
- O endpoint retorna a situação atual da solicitação associada ao
tiqueteSolicitacao. - Quando
estado=CONCLUIDA, são retornadosurlAssinadaeurlAssinadaExpiraEm. - Quando
estado=ERRO, são retornadoscodigoErroemensagemErro.
4. Endpoint da api
-
URL de Produção Restrita:
https://api.receitafederal.gov.br/apuracao-cbs-prr/v2/situacao/{tiqueteSolicitacao}
-
URL de Produção:
https://api.receitafederal.gov.br/apuracao-cbs/v2/situacao/{tiqueteSolicitacao}
4.1 Campos de entrada
| Campo | Formato | Descrição |
|---|---|---|
| tiqueteSolicitacao | String | Tíquete da solicitação. |
4.2 Header
| Campo | Formato | Descrição |
|---|---|---|
| Authorization | String | Bearer <token de acesso> |
4.3 Método e exemplo de requisição
Método:GET
curl --location 'https://api.receitafederal.gov.br/apuracao-cbs-prr/v2/situacao/{tiqueteSolicitacao}' \
--header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
Exemplo com dados fictícios (Produção Restrita):
curl --location 'https://api.receitafederal.gov.br/apuracao-cbs-prr/v2/situacao/{tiqueteSolicitacao}' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.dadoFicticio.assinaturaFicticia' \
--header 'Accept: application/json'
4.4 Campos retornados
| Campo | Formato | Descrição |
|---|---|---|
| estado | String | PENDENTE, EM_PROCESSAMENTO, CONCLUIDA ou ERRO - Situação da solicitação |
| urlAssinada | String | Retornado quando estado=CONCLUIDA. URL pré-assinada para download do arquivo. |
| urlAssinadaExpiraEm | String (date-time) | Retornado quando estado=CONCLUIDA. Data/hora de expiração da URL pré-assinada. |
| codigoErro | String | Retornado quando estado=ERRO. Código técnico da falha. |
| mensagemErro | String | Retornado quando estado=ERRO. Descrição legível da falha. |
4.5 Exemplos de retorno
Sucesso (HTTP 200):
{
"estado": "CONCLUIDA",
"urlAssinada": "https://api.receitafederal.gov.br/prr-rtc/download/v2/692b7b25-44cb-4415-8625-2b9522dd7933.B5E08D55",
"urlAssinadaExpiraEm": "2026-08-26T14:30:00Z"
}
Erro (HTTP 400/401/404/500):
{
"estado": "ERRO",
"codigoErro": "APURACAO-408",
"mensagemErro": "Tempo limite de processamento excedido (240 minutos)."
}