Rota de consulta

Como consultar o protocolo do lote no RESocial via request.

Esta rota consulta o processamento do lote já enviado e devolve o status final, mensagem, recibos, ocorrências e o JSON do evento quando o XML estiver disponível.

Voltar para o índice de rotas Voltar para envio

POST /api-esocial/consulta-protocolo

Campos centrais

ambiente, protocolo e event_id

Resolução

Contexto resolvido localmente pelo event_id

Retorno

status, mensagem, recibos e json_evento

Body JSON

Campos aceitos pela rota de consulta.

Campo	Obrigatório	Descrição
`ambiente`	Required	`1` para produção e `2` para produção restrita.
`protocolo`	Required	Protocolo criptografado devolvido no envio. O valor precisa começar com `FP1`.
`event_id`	Required	Identificador do evento devolvido pela rota de envio.

Comportamento da rota

Se a API não conseguir resolver o contexto localmente pelo event_id, a consulta é rejeitada.
Os headers CNPJ e TOKEN são obrigatórios em todos os requests dessa API.
Quando o XML do evento já existir localmente, a resposta inclui json_evento.
Se o protocolo não estiver no formato esperado, a consulta é rejeitada.

Exemplo prático

Exemplo de request para consultar o protocolo.

A consulta devolve event_id, event_type, status, mensagem, recibos, ocorrencias e json_evento.

POST /api-esocial/consulta-protocolo

cURL

curl -X POST "https://resocial.com.br/api-esocial/consulta-protocolo" \
  -H "CNPJ: 12345678000190" \
  -H "TOKEN: seu_token_de_api" \
  -H "Content-Type: application/json" \
  -d '{
    "ambiente": "2",
    "protocolo": "FP1...",
    "event_id": "ID1234567890000002026031815300000001"
  }'

POST /api-esocial/consulta-protocolo

Python

import requests

url = "https://resocial.com.br/api-esocial/consulta-protocolo"
headers = {
    "CNPJ": "12345678000190",
    "TOKEN": "seu_token_de_api",
}
payload = {
    "ambiente": "2",
    "protocolo": "FP1...",
    "event_id": "ID1234567890000002026031815300000001",
}

response = requests.post(url, headers=headers, json=payload, timeout=60)
print(response.status_code)
print(response.json())

INFO

Resposta esperada

A consulta devolve event_id, event_type, status, mensagem, recibos, ocorrencias e json_evento.

Resposta (JSON)

{
  "event_id": "ID1234567890000002026031815300000001",
  "event_type": "S-1299",
  "status": "201",
  "mensagem": "Lote processado com sucesso",
  "recibos": ["1.2.0000000000000000000"],
  "ocorrencias": [],
  "json_evento": {
    "s1299": [
      {
        "perApur": "2026-03",
        "evtRemun": "S"
      }
    ]
  }
}