Validador de E-Fatura NRS FIRS Nigéria API

API ID 13425

Validador de e-fatura Keyless Nigeria NRS (ex-FIRS): XSD oficial UBL 2.1, regras básicas Peppol BIS, TIN nigeriano para ambas as partes, IVA por linha, blocos de liberação IRN/CSID/QR. Relatório em JSON codificado por regras

297 ms resp. média

Documentação da API

Endpoints

Requisição
Sonda de vivacidade simples para monitoramento e verificação de tempo de atividade Retorna {"status":"ok"} com HTTP 200 quando o serviço de validação está ativo e pronto para aceitar documentos Nenhum parâmetro nenhum corpo é necessário
Endpoint ID: 29082
GET https://zylalabs.com/api/13425/nigeria+nrs+firs+e-invoice+validator+api/29082/health+check
PARÂMETROS DE ENTRADA

Solicitações gratuitas de teste restantes: 3 de 3.

Este endpoint não requer parâmetros de entrada.

RESPOSTA DE EXEMPLO DA API
JSON
{
    "status": "ok"
}
Cheque de saúde — TRECHOS DE CÓDIGO

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' 


    
Requisição
POST a fatura bruta como o corpo da solicitação (UBL 2.1 XML com Content-Type: application/xml ou JSON). Retorna um relatório de validação JSON: válido, bemFormado, tipoDocumento, temIRN, temCSID, temQR, contagemErros, contagemAvisos e descobertas detalhadas codificadas em regras (NG-STRUCT-*, NG-BIS-*, NG-RULE-*, NG-IRN-*, NG-CSID-*, NG-QR-*) cobrindo o XSD oficial OASIS UBL 2.1, campos base EN 16931 / Peppol BIS 3.0, a camada NRS da Nigéria (TIN em ambas as partes, IVA por linha, NGN) e a presença estrutural dos blocos de liberação IRN/CSID/QR. Uma fatura não conforme ainda é HTTP 200 - o veredicto é "válido": falso dentro do JSON
Endpoint ID: 29084
POST https://zylalabs.com/api/13425/nigeria+nrs+firs+e-invoice+validator+api/29084/validate+e-invoice
PARÂMETROS DE ENTRADA

Validar nota fiscal eletrônica — Recursos do endpoint

Objeto Descrição
Corpo da requisição Obrigatório Json

Solicitações gratuitas de teste restantes: 3 de 3.


PARÂMETROS DE ENTRADA

RESPOSTA DE EXEMPLO DA API
JSON
{
    "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
        }
    ]
}
Validar nota fiscal eletrônica — TRECHOS DE CÓDIGO

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
    
  
'

    

Chave de acesso à API e autenticação

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çalhos
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 🎉)

🚀 Plano Empresarial

A partir de
$ 10.000/Ano


  • Volume personalizado
  • Limite de taxa personalizado
  • Suporte ao cliente especializado
  • Monitoramento de API em tempo real

Visão Geral

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

Validador de E-Fatura NRS FIRS Nigéria API FAQs

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

Perguntas Frequentes Gerais

O Zyla API Hub é como uma grande loja de APIs, onde você pode encontrar milhares delas em um só lugar. Também oferecemos suporte dedicado e monitoramento em tempo real de todas as APIs. Após se cadastrar, você pode escolher quais APIs deseja usar. Lembre-se apenas de que cada API precisa de sua própria assinatura. Mas se você se inscrever em várias, usará a mesma chave para todas elas, facilitando as coisas para você.
Os preços são listados em USD (Dólar Americano), EUR (Euro), CAD (Dólar Canadense), AUD (Dólar Australiano) e GBP (Libra Esterlina). Aceitamos todos os principais cartões de débito e crédito. Nosso sistema de pagamento usa a mais recente tecnologia de segurança e é operado pela Stripe, uma das empresas de pagamento mais confiáveis do mundo. Se tiver problemas para pagar com cartão, entre em contato conosco em [email protected]

Além disso, se você já tiver uma assinatura ativa em qualquer uma dessas moedas (USD, EUR, CAD, AUD, GBP), essa moeda será mantida para assinaturas subsequentes. Você pode alterar a moeda a qualquer momento, desde que não tenha assinaturas ativas.
A moeda local exibida na página de preços é baseada no país do seu endereço IP e é fornecida apenas como referência. Os preços reais são em USD (Dólar Americano). Ao efetuar o pagamento, a cobrança aparecerá no extrato do seu cartão em USD, mesmo que você veja o valor equivalente em sua moeda local em nosso site. Isso significa que você não pode pagar diretamente com sua moeda local.
Ocasionalmente, o banco pode recusar a cobrança devido às configurações de proteção contra fraude. Sugerimos contatar seu banco inicialmente para verificar se estão bloqueando nossas cobranças. Você também pode acessar o Portal de Cobrança e alterar o cartão associado para realizar o pagamento. Se isso não funcionar e precisar de mais ajuda, entre em contato com nossa equipe em [email protected]
Os preços são determinados por uma assinatura recorrente mensal ou anual, dependendo do plano escolhido.
As chamadas de API são descontadas do seu plano com base nas requisições bem-sucedidas. Cada plano possui um número específico de chamadas por mês. Apenas chamadas bem-sucedidas, indicadas por uma resposta com Status 200, serão contabilizadas, garantindo que falhas não afetem sua cota mensal.
O Zyla API Hub funciona com um sistema de assinatura mensal recorrente. Seu ciclo de cobrança começa no dia em que você compra um dos planos pagos e será renovado no mesmo dia do mês seguinte. Portanto, cancele sua assinatura com antecedência se quiser evitar cobranças futuras.
Para fazer upgrade do seu plano atual, acesse a página de preços da API e selecione o novo plano desejado. O upgrade é instantâneo, permitindo aproveitar imediatamente os recursos do novo plano. Observe que as chamadas restantes do plano anterior não serão transferidas; você será cobrado pelo valor integral do novo plano.
Para verificar quantas chamadas de API restam para o mês atual, consulte o campo 'X-Zyla-API-Calls-Monthly-Remaining' no cabeçalho da resposta. Por exemplo, se seu plano permite 1.000 requisições por mês e você usou 100, este campo no cabeçalho da resposta indicará 900 chamadas restantes.
Para ver o número máximo de requisições de API que seu plano permite, verifique o cabeçalho de resposta 'X-Zyla-RateLimit-Limit'. Por exemplo, se seu plano inclui 1.000 requisições por mês, este cabeçalho exibirá 1.000.
O cabeçalho 'X-Zyla-RateLimit-Reset' mostra o número de segundos até seu limite de taxa ser redefinido. Isso informa quando sua contagem de requisições começará do zero. Por exemplo, se exibir 3.600, significa que restam 3.600 segundos até o limite ser redefinido.
Sim, você pode cancelar seu plano a qualquer momento acessando sua conta e selecionando a opção de cancelamento na página de Cobrança. Observe que upgrades, downgrades e cancelamentos têm efeito imediato. Além disso, após o cancelamento, você não terá mais acesso ao serviço, mesmo que ainda tenha chamadas restantes na sua cota.
Para oferecer a oportunidade de experimentar nossas APIs sem compromisso, oferecemos um teste gratuito de 7 dias que permite realizar até 50 chamadas de API sem custo. Esse teste pode ser usado apenas uma vez; recomendamos aplicá-lo à API que mais interessa. Embora a maioria das APIs ofereça teste gratuito, algumas podem não oferecer. O teste termina após 7 dias ou quando você atingir 50 requisições, o que ocorrer primeiro. Se atingir o limite, será necessário "Iniciar seu plano pago" para continuar. Você encontra esse botão no perfil em Assinatura -> Escolha a API -> aba Preços. Se não cancelar até o 7º dia, sua assinatura será cobrada automaticamente, liberando todas as chamadas do plano.
Após 7 dias, será cobrado o valor total do plano ao qual você estava inscrito durante o teste. Portanto, é importante cancelar antes do término do período. Solicitações de reembolso por esquecimento de cancelamento não são aceitas.
Ao assinar um teste gratuito de API, você pode fazer até 50 chamadas. Se desejar fazer chamadas adicionais além desse limite, a API solicitará que você "Inicie seu plano pago". Você encontra o botão no perfil em Assinatura -> Escolha a API -> aba Preços.
As Ordens de Pagamento são processadas entre os dias 20 e 30 de cada mês. Se você enviar sua solicitação antes do dia 20, seu pagamento será processado dentro desse período.
Você pode nos contatar via chat para receber assistência imediata. Estamos online de 8h às 17h (EST). Se nos contatar após esse horário, retornaremos o mais rápido possível. Além disso, você pode enviar um e-mail para [email protected]

APIs relacionadas