{
"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
'
After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Nigeria NRS FIRS E-Invoice Validator API simply include your bearer token in the Authorization header.
| Header | Description |
|---|---|
Authorization
|
Required
Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.
|
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
(Save 2 months with annual billing 🎉)
Keyless Nigeria NRS (ex-FIRS) e-invoice validator: official UBL 2.1 XSD, Peppol BIS base rules, Nigerian TIN on both parties, per-line VAT, IRN/CSID/QR clearance blocks. Rule-coded JSON report.
The GET Health check endpoint returns a simple JSON object indicating the service status, while the POST Validate e-invoice endpoint returns a detailed JSON validation report that includes fields like validity, well-formedness, document type, and findings related to compliance with UBL 2.1 and Nigerian regulations.
Key fields in the validation report include "valid," "wellFormed," "documentType," "hasIRN," "hasCSID," "hasQR," "errorCount," "warningCount," and "findings," which provide detailed compliance information and rule violations.
The returned data is in JSON format. The structure includes a top-level object with fields for validation status and findings, where "findings" is an array of objects detailing specific rule violations, their severity, and occurrences.
The GET Health check provides service status, while the POST Validate e-invoice offers comprehensive validation details, including compliance with UBL 2.1, Peppol BIS rules, and specific Nigerian requirements like TIN and VAT.
The response data is organized into a main object containing validation results and an array of findings. Each finding includes fields such as "level," "ruleId," "text," "location," and "occurrences," allowing users to easily identify issues.
The data is based on official standards, including the OASIS UBL 2.1 XSD and Peppol BIS base rules, ensuring compliance with Nigerian regulations. The validator checks against these standards to maintain data accuracy.
Typical use cases include validating e-invoices for compliance with Nigerian tax regulations, ensuring proper formatting for electronic submissions, and identifying errors or warnings before submission to tax authorities.
Users can analyze the validation report to identify compliance issues, track error counts, and review specific findings to make necessary corrections to invoices, ensuring they meet regulatory requirements before submission.
To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.
You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.
The free trial lasts for 7 days and allows you to make up to 50 API requests.
No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.
Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
You can monitor your API usage through the response headers included with every request:
x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.
Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.
Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund