{
"status": "ok"
}
curl --location --request GET 'https://zylalabs.com/api/13425/nigeria+nrs+firs+e-invoice+validator+api/29082/health+check' --header 'Authorization: Bearer YOUR_API_KEY'
{
"valid": true,
"wellFormed": true,
"inputFormat": "xml",
"documentType": "380",
"hasIRN": true,
"hasCSID": true,
"hasQR": true,
"errorCount": 0,
"warningCount": 0,
"findings": [
{
"level": "info",
"ruleId": "NG-STRUCT-XSD",
"text": "Document is valid against the official OASIS UBL 2.1 Invoice XSD.",
"location": null,
"occurrences": 1
},
{
"level": "info",
"ruleId": "NG-IRN-PRESENT",
"text": "IRN present (structure only; NRS-issued authenticity not cryptographically verified): IRN-4c2f9d3e8a1b47f0b6c5d2e1f0a9b8c7",
"location": "IRN",
"occurrences": 1
},
{
"level": "info",
"ruleId": "NG-CSID-PRESENT",
"text": "CSID / cryptographic stamp block present. STRUCTURE ONLY: this validator does not hold the NRS signing certificate and cannot verify the stamp's cryptographic authenticity.",
"location": "ext:UBLExtensions",
"occurrences": 1
},
{
"level": "info",
"ruleId": "NG-QR-PRESENT",
"text": "QR present and base64-decodable (36 bytes). STRUCTURE ONLY: QR contents are not cross-checked against an NRS-issued signature.",
"location": "cac:AdditionalDocumentReference[ID='QR']",
"occurrences": 1
}
]
}
curl --location --request POST 'https://zylalabs.com/api/13425/nigeria+nrs+firs+e-invoice+validator+api/29084/validate+e-invoice' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '
2.1
urn:cen.eu:en16931:2017#compliant#urn:fdc:nrs.gov.ng:ng-einvoice:1.0
urn:fdc:peppol.eu:2017:poacc:billing:01:1.0
NG-INV-2025-000123
IRN-4c2f9d3e8a1b47f0b6c5d2e1f0a9b8c7
2025-11-03
10:15:00
380
NGN
NGN
CSID
NRS Cryptographic Stamp Identifier
Q1NJRC1QTEFDRUhPTERFUi1zdHJ1Y3R1cmUtb25seS1ub3QtdmVyaWZpZWQ=
QR
QR
UVItUExBQ0VIT0xERVItYmFzZTY0LXN0cnVjdHVyZS1vbmx5
Lagos Trading Company Limited
12 Marina Road
Lagos
Lagos
NGA
12345678-0001
VAT
Lagos Trading Company Limited
RC-1234567
Abuja Retail Ventures Limited
5 Ademola Adetokunbo Crescent
Abuja
FCT
NGA
87654321-0001
VAT
Abuja Retail Ventures Limited
RC-7654321
2250.00
30000.00
2250.00
S
7.5
VAT
30000.00
30000.00
32250.00
32250.00
1
2
10000.00
Office chairs, ergonomic
Ergonomic office chair
S
7.5
VAT
5000.00
2
1
20000.00
Executive desk, mahogany
Executive desk
S
7.5
VAT
20000.00
'
Após se cadastrar, cada desenvolvedor recebe uma chave de acesso à API pessoal, uma combinação única de letras e dígitos para acessar nosso endpoint de API. Para autenticar com a Validador de E-Fatura NRS FIRS Nigéria API basta incluir seu token Bearer no cabeçalho Authorization.
| Cabeçalho | Descrição |
|---|---|
Authorization
|
Obrigatório
Deve ser Bearer access_key. Veja "Sua chave de acesso à API" acima quando você estiver inscrito.
|
Sem compromisso de longo prazo. Faça upgrade, downgrade ou cancele a qualquer momento. O teste gratuito inclui até 50 requisições.
(Economize 2 meses com cobrança anual 🎉)
Validador de e-fatura Keyless Nigeria NRS (ex-FIRS): UBL 2.1 XSD oficial, regras básicas Peppol BIS, TIN nigeriano para ambas as partes, IVA por linha, blocos de liberação IRN/CSID/QR. Relatório JSON codificado por regras
O endpoint GET Health check retorna um simples objeto JSON indicando o status do serviço enquanto o endpoint POST Validate e-invoice retorna um relatório de validação JSON detalhado que inclui campos como validade, conformidade, tipo de documento e constatações relacionadas à conformidade com UBL 2.1 e regulamentações nigerianas
Os campos-chave no relatório de validação incluem "válido", "bemFormado", "tipoDeDocumento", "temIRN", "temCSID", "temQR", "contagemDeErros", "contagemDeAvisos" e "constatações" que fornecem informações detalhadas de conformidade e violações de regras
Os dados retornados estão no formato JSON A estrutura inclui um objeto de nível superior com campos para status de validação e constatações onde "constatações" é um array de objetos detalhando violações específicas de regras sua gravidade e ocorrências
A verificação de saúde GET fornece o status do serviço enquanto o POST Validar e-fatura oferece detalhes de validação abrangentes incluindo conformidade com UBL 2.1 regras Peppol BIS e requisitos específicos da Nigéria como TIN e VAT
Os dados da resposta estão organizados em um objeto principal contendo resultados de validação e uma matriz de constatações. Cada constatação inclui campos como "nível", "ruleId", "texto", "localização" e "ocorrências", permitindo que os usuários identifiquem facilmente os problemas
Os dados são baseados em padrões oficiais, incluindo o XSD OASIS UBL 2.1 e as regras básicas do Peppol BIS, assegurando conformidade com as regulamentações nigerianas. O validador verifica esses padrões para manter a precisão dos dados
Os casos de uso típicos incluem validar e-faturas para conformidade com as regulamentações fiscais nigerianas garantir o formato adequado para envios eletrônicos e identificar erros ou avisos antes da submissão às autoridades fiscais
Os usuários podem analisar o relatório de validação para identificar problemas de conformidade rastrear contagens de erros e revisar descobertas específicas para fazer as correções necessárias nas faturas garantindo que atendam aos requisitos regulatórios antes da submissão