Skip to main content
POST
/
validate
/
nf
Validar Nota Fiscal
curl --request POST \
  --url https://production.api.noodle.cx/external/validate/nf \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'data=<string>' \
  --form file='@example-file'
{
  "valid": true,
  "message": "<string>",
  "fields": [
    {
      "valid": true,
      "field_name": "<string>",
      "request_value": "<string>",
      "extracted_value": "<string>",
      "confidence_score": 123,
      "message": "O valor corresponde ao extraído."
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developer.noodle.cx/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Body

multipart/form-data
​
data
string
required

Uma string JSON contendo os seguintes campos (todos opcionais):

  • due_date (Optional): Data de vencimento da Nota Fiscal.
    • Exemplo: 2025-12-31
  • invoice_date (Optional): Data de emissão da Nota fiscal.
    • Exemplo: 2025-11-30
  • invoice_id (Optional): Número de identificação da nota fiscal.
    • Exemplo: 123456
  • receiver_email (Optional): E-mail do sacado (destinatário/comprador).
    • Exemplo: comprador@email.com
  • receiver_name (Optional): Nome ou razão social do sacado (destinatário/comprador).
    • Exemplo: Empresa Compradora LTDA
  • receiver_tax_id (Optional): CNPJ ou CPF do sacado (destinatário/comprador).
    • Exemplo: 11.222.333/0001-44
  • supplier_address (Optional): Endereço do cedente (emissor/vendedor).
    • Exemplo: Rua Exemplo, 123, São Paulo, SP
  • supplier_name (Optional): Nome ou razão social do cedente (emissor/vendedor).
    • Exemplo: Empresa Vendedora S.A.
  • supplier_tax_id (Optional): CNPJ ou CPF do cedente (emissor/vendedor).
    • Exemplo: 55.666.777/0001-88
  • total_amount (Optional): Valor total da nota fiscal.
    • Exemplo: 1500.5
​
file
file
required

Arquivo da Nota Fiscal (PDF) para extração e validação dos dados.

Response

Successful Response

Modelo de resposta para a validação da Nota Fiscal.

​
valid
boolean
required

Indica se TODOS os campos enviados foram validados com sucesso.

​
message
string | null

Mensagem adicional, geralmente explicando o motivo de uma falha.

​
fields
NFValidationFieldResponse · object[]

Lista com os resultados detalhados da validação de cada campo.