Pular para o conteúdo principal

Checar

Objetivo do Endpoint

Este endpoint permite validar se uma chave de acesso está disponível nos servidores da GuardaNFe, indicando que a respectiva NF-e foi previamente armazenada com sucesso. A verificação é restrita às NF-e associadas à sua conta, garantindo segurança e confidencialidade dos seus documentos fiscais.

Endpoint:

POST /GuardaNFe/Checar

Body (JSON):

{
"chavesNFe": [
"11220108333830000304550010000000881000001108",
"43210312345678000123450010000000201234567890"
]
}

Descrição:

Este endpoint verifica se os arquivos XML das NF-es especificadas existem no GuardaNFe.


Parâmetros:

NomeTipoObrigatórioDescrição
chavesNFearray de strings✅ SimLista de chaves NF-e para verificação

Exemplo de Requisição (cURL)

curl -X POST "https://api.validanfe.com/GuardaNFe/Checar" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "X-API-KEY: SEU_TOKEN_AQUI" \
-d '{
"chavesNFe": [
"11220108333830000304550010000000881000001108",
"43210312345678000123450010000000201234567890"
]
}'

Respostas possíveis

✅ 200 OK - Resposta bem-sucedida

{
"11220108333830000304550010000000881000001108": { "exists": true },
"43210312345678000123450010000000201234567890": { "exists": false }
}

Se exists: true, o arquivo XML da NF-e está presente no GuardaNFe.
Se exists: false, o arquivo XML não foi encontrado no GuardaNFe.


❌ 400 BAD REQUEST - Lista vazia

{
"message": "A lista de chaves NF-e está vazia."
}

Ocorre quando o corpo da requisição está vazio ou nulo.


❌ 500 INTERNAL SERVER ERROR - Erro interno

{
"message": "Erro ao verificar a existência dos arquivos.",
"error": "Descrição do erro."
}

Ocorre quando há um erro inesperado no processamento.