Identificador da requisição

Cada resposta processada pela API inclui um identificador da tentativa. Guarde esse valor junto do status e do horário quando precisar investigar uma requisição.

Request-Id é um header de resposta. Não envie esse nome na requisição nem tente escolher o valor.

Onde encontrar

A resposta contém o header principal e um alias com o mesmo valor:

Request-Id: req_4ZxYp8Q2mV7nR6sT5uW3aB
X-Request-Id: req_4ZxYp8Q2mV7nR6sT5uW3aB

Use Request-Id nas novas integrações. X-Request-Id existe para compatibilidade.

No Raims CLI, o campo aparece como request_id na saída JSON e como Request-Id na saída de texto. O console desta documentação mostra o valor na resposta real e permite copiá-lo. Exemplos de resposta não têm um ID real.

Informar ao suporte

Ao pedir ajuda sobre uma resposta da API, informe o Request-Id, o horário aproximado e o endpoint chamado. Não envie a chave da API, o segredo de webhook nem o payload com dados do cliente.

O identificador ajuda a localizar uma tentativa quando os registros correspondentes estão disponíveis. A captura de logs da empresa pode estar desativada ou o histórico pode ter expirado; por isso, ter o ID não garante que a requisição ainda seja pesquisável.

Limites do identificador

Cada tentativa HTTP recebe outro Request-Id, inclusive um retry ou o replay de uma resposta idempotente. Para repetir a mesma intenção com segurança, use Idempotency-Key; não reutilize Request-Id.

O valor com prefixo req_ não é o ID do recurso, do pagamento ou de uma operação pendente. Continue usando os identificadores retornados no corpo para consultar o resultado.

O header identifica respostas processadas pela API. Uma falha gerada antes dela, por exemplo na borda ou em um proxy, pode não conter Request-Id.