Send invoices to NRS through Nvono

Nvono is a NRS-accredited Access Point Provider. Post your invoice data to this API and Nvono validates it, signs it with NRS, and transmits it on your behalf — returning the IRN, cryptographic stamp, and QR code, with live status delivered to your webhook.

There are two ways to integrate, depending on where invoices get signed:

• Nvono signs & transmits — you send raw invoice data; Nvono handles validation, signing, and transmission. See the guide →
• You sign, Nvono transmits — you already hold NRS-signed IRNs and only need the Access Point to transmit them. See the guide →

Authentication

Every request is authenticated with an API key sent in the x-api-key header. Generate your key in the Nvono platform under Settings → API Keys. The full key is shown only once at creation, so store it securely.

GET /api/v1/documents HTTP/1.1
Host: api.nvono.com
x-api-key: nvo_live_9f2c7b1a8e64d0f3c5a1b7e2

Keys carry scopes that limit what they can do. For the full send-and-transmit flow, your key needs: documents:write, documents:read, firs:sign, and firs:transmit.

Requests & responses

Successful responses wrap the result in a consistent envelope:

{
  "success": true,
  "data": { /* the resource */ },
  "meta": { "timestamp": "2026-07-09T09:14:36.818Z", "requestId": "1801a93b-…" }
}

Errors use the same shape with success: false. The error.code is stable and machine-readable; error.details lists field-level validation messages.

{
  "success": false,
  "error": {
    "code": "BAD_REQUEST",
    "message": "telephone must start with the character +",
    "details": [ { "message": "..." } ]
  },
  "meta": { "timestamp": "…", "path": "/api/v1/documents", "requestId": "…" }
}

Quote the requestId when contacting support. Validation is strict — unknown fields are rejected with 400, so send only the documented fields.

Idempotency

Safely retry a create after a network timeout by sending an Idempotency-Key header — any unique string you generate per logical request (a UUID works well). If Nvono has already processed that key, it returns the original response instead of creating a second document.

POST /api/v1/documents
x-api-key: nvo_live_…
Idempotency-Key: a1f3c9e2-7b64-4d0f-9c5a-1b7e2c8d4f60

• Reuse the same key on a retry → you get the first response back, no duplicate.
• Same key with a different body → 422 (the key is bound to its first payload).
• Retry while the first request is still running → 409; wait and retry.

Keys are remembered for 24 hours and scoped to your account. Currently honoured on POST /documents.

The invoice lifecycle

An invoice moves through these stages. Nvono tracks the first four on firsStatus and the last two on transmissionStatus.

Guide: submit, sign & transmit

Use this when you want Nvono to do everything from raw invoice data.

Step 1 — Create the document

Post the invoice. See the field reference for every option.

curl -X POST https://api.nvono.com/api/v1/documents \
  -H "x-api-key: nvo_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "documentType": "invoice",
    "documentNumber": "INV-2026-00042",
    "documentDate": "2026-07-09",
    "transactionType": "B2B",
    "currency": "NGN",
    "firsEnabled": true,
    "counterparty": {
      "name": "Dean & Davis Ltd",
      "tin": "01281054-0001",
      "email": "accounts@deandavis.ng",
      "phone": "+2348021234567",
      "address": "20 Rumuibekwe Road",
      "city": "Port Harcourt",
      "stateCode": "RI",
      "countryCode": "NG"
    },
    "lines": [{
      "description": "Magnesium Oxide",
      "quantity": 147.163,
      "unitPrice": 53000,
      "unit": "KGM",
      "itemType": "goods",
      "hsCode": "2519.90",
      "taxes": [{ "taxTypeCode": "VAT-STD" }]
    }]
  }'

The response returns the new document with "documentStatus": "draft" and an id (UUID). Use that id in the next steps. documentStatus is the document's own lifecycle — draft → final (after finalize) → void — distinct from firsStatus (signing) and transmissionStatus (delivery). When listing, the query param that filters it is named status (see listing & filtering).

Taxes on a line

Each line needs its tax treatment. There are two ways to declare it.

1 — By tax type (recommended, used in Step 1 above). Pass a taxes array where each entry references a configured tax type by taxTypeCode (or taxTypeId). Nvono resolves the rate, whether it is inclusive or exclusive, whether it is withholding (WHT), and the NRS tax category from that record — so you only send the reference. You can send more than one (e.g. VAT + WHT):

"lines": [{
  "description": "Consulting",
  "quantity": 1,
  "unitPrice": 100000,
  "itemType": "service",
  "serviceCode": "83121500",
  "taxes": [
    { "taxTypeCode": "VAT-STD" },
    { "taxTypeCode": "WHT-5" }
  ]
}]

Discover the tax types available to you (codes, rates, labels) with GET /firs/resources/tax-types.

2 — Simple (VAT only, tax-exclusive). If you don't use tax types, set taxCategory and taxRate instead. The unit price is treated as net and VAT is added on top — e.g. "taxCategory": "S", "taxRate": 7.5.

Step 2 — Finalize & sign

Finalizing with submitToFirs: true runs the full signing workflow automatically: validate IRN → validate invoice → sign → generate QR.

curl -X POST https://api.nvono.com/api/v1/documents/{id}/finalize \
  -H "x-api-key: nvo_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "submitToFirs": true }'

On success the document carries signed firsStatus, plus irn, csid (cryptographic stamp), and qrCode.

Step 3 — Transmit

Signing does not transmit. Send the signed invoice through the Access Point:

curl -X POST https://api.nvono.com/api/v1/firs/transmit/{id}/transmit \
  -H "x-api-key: nvo_live_…"

The repeated transmit is intentional — the resource group is /firs/transmit and /{id}/transmit is the action on it.

transmissionStatus becomes transmitting, then transmitted and finally acknowledged as NRS confirms. To transmit many at once, use POST /firs/transmit/bulk with { "documentIds": ["…"] }.

Step 4 — Track status

Either fetch the document, or (recommended) let Nvono call your webhook on every change.

curl https://api.nvono.com/api/v1/documents/{id} \
  -H "x-api-key: nvo_live_…"

Guide: transmit an already-signed IRN

If your invoices are signed with NRS elsewhere and you only need Nvono as the transmitting Access Point, skip creation and signing entirely. Submit the IRNs directly.

curl -X POST https://api.nvono.com/api/v1/firs/transmit/by-irn \
  -H "x-api-key: nvo_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [{
      "irn": "INV36N5D00002-08106EF2-20260708",
      "documentType": "invoice",
      "transactionType": "B2B",
      "documentNumber": "INV-36N5D-00002",
      "supplierName": "Aluminium Smelter Co.",
      "supplierTin": "01056765-0001",
      "buyerName": "Dean & Davis Ltd",
      "buyerTin": "01281054-0001"
    }]
  }'

Each IRN must already be signed in NRS. Only irn is required per item; the rest help Nvono record the transmission. Then poll status for up to 100 IRNs at once:

curl "https://api.nvono.com/api/v1/firs/transmit/by-irn/status?irns=INV36N5D00002-08106EF2-20260708,INV…" \
  -H "x-api-key: nvo_live_…"

The response returns a results array with each IRN's current transmission status.

Status webhooks

Rather than polling, register a URL and Nvono will POST to it on two kinds of event — when an invoice is signed or rejected (document.firs_status_changed) and when Access Point delivery progresses (transmission.status_changed). Configure it once:

curl -X PATCH https://api.nvono.com/api/v1/tenants/me/webhook \
  -H "x-api-key: nvo_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "webhookUrl": "https://yourapp.example/hooks/nvono",
    "webhookSecret": "whsec_your_random_secret",
    "webhookEnabled": true
  }'

Event: document.firs_status_changed

Fires when a document's signing state reaches validated, signed, rejected, or cancelled — so you can stop polling for the signing result.

{
  "event": "document.firs_status_changed",
  "documentId": "4d7fcac6-f8d3-4897-aa05-6b4392df2fe2",
  "irn": "INV36N5D00002-08106EF2-20260708",
  "firsStatus": "signed",
  "timestamp": "2026-07-09T09:18:00.000Z",
  "data": {
    "documentNumber": "INV-2026-00042",
    "previousStatus": "validated",
    "newStatus": "signed",
    "reason": null
  }
}

Event: transmission.status_changed

Fires as the Access Point delivers a signed invoice (transmitting → transmitted → acknowledged, or failed).

{
  "event": "transmission.status_changed",
  "irn": "INV36N5D00002-08106EF2-20260708",
  "documentId": "4d7fcac6-f8d3-4897-aa05-6b4392df2fe2",
  "transmissionStatus": "acknowledged",
  "timestamp": "2026-07-09T09:20:00.000Z",
  "data": {
    "documentNumber": "INV-2026-00042",
    "previousStatus": "transmitted",
    "newStatus": "acknowledged",
    "reason": null
  }
}

Invoice fields

Body for POST /documents. Unknown fields are rejected.

Top level

counterparty

lines[]

Credit & debit notes

A credit_note or debit_note adjusts an earlier invoice, so NRS requires it to reference that original invoice. Create it exactly like an invoice (POST /documents) but set documentType accordingly and supply referenceDocumentNumber.

POST /documents
{
  "documentType": "credit_note",
  "documentDate": "2026-08-04",
  "referenceDocumentNumber": "INVGJDMY00069-5C9D0ABD-20260717",
  "counterparty": { "name": "ABC Company Limited", "tin": "12345678-0001" },
  "lines": [
    { "description": "Returned goods", "quantity": 1, "unitPrice": 90000,
      "taxCategory": "S", "taxRate": 7.5 }
  ]
}

Finalize and sign the note the same way as an invoice (see Step 2). The original invoice does not need to have been signed through Nvono — a valid IRN issued elsewhere is accepted.

Listing & filtering

GET /documents is paginated and filterable. All parameters are optional query-string values; combine them freely.

curl "https://api.nvono.com/api/v1/documents?documentType=invoice&firsStatus=signed&dateFrom=2026-07-01&dateTo=2026-07-31&page=1&limit=50" \
  -H "x-api-key: nvo_live_…"

The response data is an array of documents and meta carries total, page, and limit for paging.

Recording payments

POST /documents/{id}/payment-status records a payment against a document and supports partial payments — call it multiple times as instalments arrive. Requires documents:write.

paymentMeans is an NRS payment-means code — the UN/CEFACT code NRS records on the invoice. Common values: 10 · Cash 20 · Cheque 30 · Credit Transfer 48 · Bank Card 42 · ACH Credit 97 · Other ZZZ · Mutually Defined. Fetch the full, current catalogue from GET /firs/resources/firs-payment-means.

An unrecognised code is rejected with 400 (it is not silently coerced to “Other”), and no payment is recorded.

curl -X POST https://api.nvono.com/api/v1/documents/{id}/payment-status \
  -H "x-api-key: nvo_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "amountPaid": 250000,
    "paymentMeans": "30",
    "paymentReference": "FT26190XYZ",
    "notes": "First instalment"
  }'

Nvono updates paymentStatus to PARTIAL or PAID based on the cumulative total versus the invoice amount, and reports the paid amount to NRS. Read the ledger with GET /documents/{id}/payments.

Endpoint reference

All paths are relative to https://api.nvono.com/api/v1.

Documents

NRS signing — granular steps

The signing flow (validate IRN → validate invoice → sign → QR) runs automatically via finalize / firs-workflow. These endpoints expose the individual steps if you need to run them separately — the two validate calls are what the firs:validate scope grants.

Transmission — Access Point

Account

Status values

A document carries three independent status fields. Don't conflate them: documentStatus is the record's own lifecycle, firsStatus is signing, transmissionStatus is Access Point delivery.

documentStatus — record lifecycle (filter param: status)

draft final void

firsStatus — signing progress

draft pending processing validated signed rejected

transmissionStatus — Access Point delivery

not_transmitted transmitting transmitted acknowledged failed

paymentStatus

PENDING PARTIAL PAID REJECTED

Recording a payment via POST /documents/{id}/payment-status yields PENDING, PARTIAL, or PAID (based on the cumulative amount). REJECTED is an NRS-side outcome — it appears when NRS rejects a reported payment — not something the payment-status call produces directly.

Key fields on a signed document: irn (invoice reference), csid (cryptographic stamp ID), and qrCode.

Code lists & lookups

Fetch NRS reference data to populate your invoices. All of these accept any valid API key — no special scope required (except currencies). Paths are relative to https://api.nvono.com/api/v1.

Rate limits

Requests are rate-limited per API key. Exceeding a limit returns 429 with error.code: RATE_LIMIT_EXCEEDED — back off and retry. A general default applies to most endpoints; a few tiers are tighter or looser by nature of the operation.

Windows are fixed 60-second buckets. Bulk transmission additionally paces its internal NRS calls (default 10/min per batch) so a single bulk request will not breach the NRS tier.

Error codes

Scopes

Assign your key the least it needs. For the send-and-transmit flow: documents:write, documents:read, firs:sign, firs:transmit.