1. Inicio
  2. Documentos
  3. NS NF3e (English)
  4. NS NF3-e API Utility Func...
  5. Consult NF3-e Status

Consult NF3-e Status

Through the NF3-e status consult service, it’s possile to obtain information of the NF3-e current status at Sefaz database.

This functionality is widely used in cases where it’s necessary to verify the existence and validity of an NF3-e, as well as to obtain information about events that occurred with it (e.g.: Cancellation).


Production: POST https://nf3e.ns.eti.br/v1/nf3e/status

Input Data
FieldDescriptionData TypeOccurrenceNotes
X-AUTH-TOKENUser access tokenString0-1
licencaCnpjCNPJ of the license interested in consulting the status of the NF3-eInt0-1Used to identify the digital certificate to be used. If not sent, the CNPJ will be extracted from the key sent in the chNF3e field
chNF3eNF3-e access keyInt1-1
tpAmbNF3-e authorization environment typeInt1-11 - Production, 2 - Homologation
Request Example

Consult status request

curl -X POST \
-H "Content-Type: application/json" \
-d '{"X-AUTH-TOKEN": "YOUR_TOKEN", "licencaCnpj": "11111111111111", "chNF3e": "11111111111111111111111111111111111111111111", "tpAmb": "2"}'\
Returned Data
FieldDescriptionOccurrenceData TypeParentNotes
statusProcessing status code1-1Int
motivoLiteral description of the processing status1-1String
retConsSitNF3eObject containing the NF3-e authorization protocol data and all linked events0-1ObjectOnly when status = 200
erroObject containing error data that occurred during processing0-1ObjectOnlye when status is different from 200
cStatError status code1-1Interro
xMotivoError literal description1-1Stringerro
Response Examples

Successful response

    "status": 200,
    "motivo": "Consulta realizada com sucesso",
    "retConsSitNF3e": {
        "tpAmb": "2",
        "verAplic": "RS20191028094248",
        "cStat": "101",
        "xMotivo": "Cancelamento de NF3e homologado ",
        "cUF": "43",
        "protNF3e": {
            "infProt": {
                "Id": "NF3e143190000000010",
                "tpAmb": "2",
                "verAplic": "RS20191028094235",
                "chNF3e": "11111111111111111111111111111111111111111111",
                "dhRecbto": "2019-12-06T15:56:29-03:00",
                "nProt": "143190000000010",
                "digVal": "tWkjZX1gzoQenHclxF5J5XxhClE=",
                "cStat": "100",
                "xMotivo": "Autorizado o uso da NF3e "
            "versao": "1.00"
        "versao": "1.00"
Return Codes
200Consultation carried out successfully
-400NF3-e key or tpAmb nor informed
-3Invalid access key
-6Error on carrying out the consultation. Verify the "erro" object to identify the reason

Como podemos ajudar?