Fiscal

Revalida a NF com os dados atuais

Reexecuta a validação determinística sobre os dados JÁ EXTRAÍDOS do arquivo, com o cadastro atual do afiliado e do pagamento; usado após corrigir o CNPJ do afiliado. Não re-extrai o arquivo (para isso, reenvie a NF). Retorna 409 com a extração em andamento (processing) ou sem extração concluída. Em caso de sucesso aprova a NF (validated) e libera o pagamento; em caso de falha registra os códigos de erro. Emite evento de validação da NF. Requer um usuário com permissão de administrador (owner ou admin).

POST

invoices

{invoiceId}

validate

Revalida a NF com os dados atuais

curl --request POST \
  --url https://api.userepass.com/invoices/{invoiceId}/validate \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.userepass.com/invoices/{invoiceId}/validate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.userepass.com/invoices/{invoiceId}/validate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.userepass.com/invoices/{invoiceId}/validate"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.userepass.com/invoices/{invoiceId}/validate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "inv_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "organizationId": "org_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "affiliateId": "aff_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "payoutId": "pay_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "status": "validated",
  "nfNumber": "12345",
  "nfSeries": "1",
  "issuerCnpj": "11222333000181",
  "nfAmountCents": 25000,
  "recipientName": "Repass Tecnologia LTDA",
  "nfAccessKey": "35260611222333000181550010000001231123456782",
  "nfIssuedAt": "2026-06-20T00:00:00.000Z",
  "extractionMethod": "xml_nfse",
  "extractionError": "unreadable_file",
  "fileKey": "invoices/inv_01J9Z3K8N2QF4T7B9XP0WMD5RC.pdf",
  "fileContentType": "application/pdf",
  "fileSizeBytes": 204800,
  "validationErrors": [
    "amount_mismatch"
  ],
  "rejectionReason": "Valor da NF diverge do payout",
  "submittedAt": "2026-06-13T12:00:00.000Z",
  "validatedAt": "2026-06-13T12:00:00.000Z",
  "rejectedAt": "2026-06-13T12:00:00.000Z",
  "canceledAt": "2026-06-13T12:00:00.000Z",
  "createdAt": "2026-06-13T12:00:00.000Z",
  "updatedAt": "2026-06-13T12:00:00.000Z"
}

Authorizations

Authorization

string

header

required

Chave de API (prefixo rstr_) enviada como Authorization: Bearer rstr_....

Path Parameters

invoiceId

string

required

Pattern: ^inv_[0-9A-HJKMNP-TV-Z]{26}$

Response

200 - application/json

Default Response

string

required

Identificador único da nota fiscal (prefixo inv_ + ULID).

Example:

"inv_01J9Z3K8N2QF4T7B9XP0WMD5RC"

organizationId

string

required

Organização (tenant) dona da nota fiscal.

Example:

"org_01J9Z3K8N2QF4T7B9XP0WMD5RC"

affiliateId

string

required

Afiliado a quem a nota fiscal se refere.

Example:

"aff_01J9Z3K8N2QF4T7B9XP0WMD5RC"

payoutId

string

required

Pagamento (payout) ao qual a nota fiscal está vinculada.

Example:

"pay_01J9Z3K8N2QF4T7B9XP0WMD5RC"

status

enum<string>

required

Status atual da nota fiscal.

Available options:

pending,

processing,

validated,

rejected,

canceled

Example:

"validated"

nfNumber

string | null

required

Número da nota fiscal extraído do arquivo. null até a extração concluir.

Example:

"12345"

nfSeries

string | null

required

Série da nota fiscal extraída do arquivo. null quando ausente.

Example:

"1"

issuerCnpj

string | null

required

CNPJ do emissor extraído do arquivo (normalizado a 14 dígitos). null até a extração concluir.

Example:

"11222333000181"

nfAmountCents

integer | null

required

Valor da NF extraído do arquivo, em centavos (ex.: 1990 = R$19,90). null até a extração concluir.

Required range: -9007199254740991 <= x <= 9007199254740991

Example:

25000

recipientName

string | null

required

Nome do tomador/destinatário extraído da NF. null até a extração concluir.

Example:

"Repass Tecnologia LTDA"

nfAccessKey

string | null

required

Chave de acesso da NF (44 dígitos na NF-e; formato próprio na NFS-e Nacional). null quando ausente do documento.

Example:

"35260611222333000181550010000001231123456782"

nfIssuedAt

string<date-time> | null

required

Data de emissão extraída da NF (ISO-8601). null quando ausente.

Example:

"2026-06-20T00:00:00.000Z"

extractionMethod

enum<string> | null

required

Como os dados foram extraídos do arquivo. null até a extração concluir.

Available options:

xml_nfe,

xml_nfse,

ai_pdf,

ai_xml

Example:

"xml_nfse"

extractionError

string | null

required

Código da falha fatal de extração (ex.: unreadable_file). null quando a extração leu o arquivo.

Example:

"unreadable_file"

fileKey

string | null

required

Referência interna do arquivo da NF armazenado. null enquanto não enviado.

Example:

"invoices/inv_01J9Z3K8N2QF4T7B9XP0WMD5RC.pdf"

fileContentType

string | null

required

Tipo MIME do arquivo da NF (PDF ou XML). null enquanto não enviado.

Example:

"application/pdf"

fileSizeBytes

integer | null

required

Tamanho do arquivo da NF em bytes. null enquanto não enviado.

Required range: -9007199254740991 <= x <= 9007199254740991

Example:

204800

validationErrors

string[] | null

required

Códigos/mensagens de erro encontrados na validação automática da NF. null quando não houve validação ou ela passou.

Example:

["amount_mismatch"]

rejectionReason

string | null

required

Motivo da rejeição manual da NF. null quando não rejeitada.

Example:

"Valor da NF diverge do payout"

submittedAt

string<date-time> | null

required

Momento do envio da NF (ISO-8601). null enquanto não enviada.

Example:

"2026-06-13T12:00:00.000Z"

validatedAt

string<date-time> | null

required

Momento da validação da NF (ISO-8601). null quando não validada.

Example:

"2026-06-13T12:00:00.000Z"

rejectedAt

string<date-time> | null

required

Momento da rejeição da NF (ISO-8601). null quando não rejeitada.

Example:

"2026-06-13T12:00:00.000Z"

canceledAt

string<date-time> | null

required

Momento do cancelamento da NF (ISO-8601). null quando não cancelada.

Example:

"2026-06-13T12:00:00.000Z"

createdAt

string<date-time>

required

Data de criação do registro da NF (ISO-8601).

Example:

"2026-06-13T12:00:00.000Z"

updatedAt

string<date-time>

required

Data da última atualização do registro da NF (ISO-8601).

Example:

"2026-06-13T12:00:00.000Z"

Revalida a NF com os dados atuais

curl --request POST \
  --url https://api.userepass.com/invoices/{invoiceId}/validate \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.userepass.com/invoices/{invoiceId}/validate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.userepass.com/invoices/{invoiceId}/validate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.userepass.com/invoices/{invoiceId}/validate"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.userepass.com/invoices/{invoiceId}/validate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "inv_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "organizationId": "org_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "affiliateId": "aff_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "payoutId": "pay_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "status": "validated",
  "nfNumber": "12345",
  "nfSeries": "1",
  "issuerCnpj": "11222333000181",
  "nfAmountCents": 25000,
  "recipientName": "Repass Tecnologia LTDA",
  "nfAccessKey": "35260611222333000181550010000001231123456782",
  "nfIssuedAt": "2026-06-20T00:00:00.000Z",
  "extractionMethod": "xml_nfse",
  "extractionError": "unreadable_file",
  "fileKey": "invoices/inv_01J9Z3K8N2QF4T7B9XP0WMD5RC.pdf",
  "fileContentType": "application/pdf",
  "fileSizeBytes": 204800,
  "validationErrors": [
    "amount_mismatch"
  ],
  "rejectionReason": "Valor da NF diverge do payout",
  "submittedAt": "2026-06-13T12:00:00.000Z",
  "validatedAt": "2026-06-13T12:00:00.000Z",
  "rejectedAt": "2026-06-13T12:00:00.000Z",
  "canceledAt": "2026-06-13T12:00:00.000Z",
  "createdAt": "2026-06-13T12:00:00.000Z",
  "updatedAt": "2026-06-13T12:00:00.000Z"
}