Check DARF - Documentation

Check DARF

curl --request POST \
  --url https://api.sandbox.trio.com.br/v2/out/darf/check \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'Trio-Version: <trio-version>' \
  --data '
{
  "accumulated_revenue_amount": {
    "amount": 0,
    "currency": "BRL"
  },
  "amount": {
    "amount": 13208,
    "currency": "BRL"
  },
  "assessment_date": "2026-01-01",
  "authentication_date": "2026-01-30",
  "due_date": "2026-01-30",
  "federal_revenue_id": "473",
  "fine_amount": {
    "amount": 1001,
    "currency": "BRL"
  },
  "interest_amount": {
    "amount": 1001,
    "currency": "BRL"
  },
  "percentage": 0,
  "phone": "+5541999381724",
  "reference_number": null,
  "taxpayer": {
    "name": "John Doe",
    "tax_number": "52998224725"
  }
}
'

import requests

url = "https://api.sandbox.trio.com.br/v2/out/darf/check"

payload = {
    "accumulated_revenue_amount": {
        "amount": 0,
        "currency": "BRL"
    },
    "amount": {
        "amount": 13208,
        "currency": "BRL"
    },
    "assessment_date": "2026-01-01",
    "authentication_date": "2026-01-30",
    "due_date": "2026-01-30",
    "federal_revenue_id": "473",
    "fine_amount": {
        "amount": 1001,
        "currency": "BRL"
    },
    "interest_amount": {
        "amount": 1001,
        "currency": "BRL"
    },
    "percentage": 0,
    "phone": "+5541999381724",
    "reference_number": None,
    "taxpayer": {
        "name": "John Doe",
        "tax_number": "52998224725"
    }
}
headers = {
    "Trio-Version": "<trio-version>",
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Trio-Version': '<trio-version>',
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    accumulated_revenue_amount: {amount: 0, currency: 'BRL'},
    amount: {amount: 13208, currency: 'BRL'},
    assessment_date: '2026-01-01',
    authentication_date: '2026-01-30',
    due_date: '2026-01-30',
    federal_revenue_id: '473',
    fine_amount: {amount: 1001, currency: 'BRL'},
    interest_amount: {amount: 1001, currency: 'BRL'},
    percentage: 0,
    phone: '+5541999381724',
    reference_number: null,
    taxpayer: {name: 'John Doe', tax_number: '52998224725'}
  })
};

fetch('https://api.sandbox.trio.com.br/v2/out/darf/check', 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.sandbox.trio.com.br/v2/out/darf/check",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'accumulated_revenue_amount' => [
        'amount' => 0,
        'currency' => 'BRL'
    ],
    'amount' => [
        'amount' => 13208,
        'currency' => 'BRL'
    ],
    'assessment_date' => '2026-01-01',
    'authentication_date' => '2026-01-30',
    'due_date' => '2026-01-30',
    'federal_revenue_id' => '473',
    'fine_amount' => [
        'amount' => 1001,
        'currency' => 'BRL'
    ],
    'interest_amount' => [
        'amount' => 1001,
        'currency' => 'BRL'
    ],
    'percentage' => 0,
    'phone' => '+5541999381724',
    'reference_number' => null,
    'taxpayer' => [
        'name' => 'John Doe',
        'tax_number' => '52998224725'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json",
    "Trio-Version: <trio-version>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.sandbox.trio.com.br/v2/out/darf/check"

	payload := strings.NewReader("{\n  \"accumulated_revenue_amount\": {\n    \"amount\": 0,\n    \"currency\": \"BRL\"\n  },\n  \"amount\": {\n    \"amount\": 13208,\n    \"currency\": \"BRL\"\n  },\n  \"assessment_date\": \"2026-01-01\",\n  \"authentication_date\": \"2026-01-30\",\n  \"due_date\": \"2026-01-30\",\n  \"federal_revenue_id\": \"473\",\n  \"fine_amount\": {\n    \"amount\": 1001,\n    \"currency\": \"BRL\"\n  },\n  \"interest_amount\": {\n    \"amount\": 1001,\n    \"currency\": \"BRL\"\n  },\n  \"percentage\": 0,\n  \"phone\": \"+5541999381724\",\n  \"reference_number\": null,\n  \"taxpayer\": {\n    \"name\": \"John Doe\",\n    \"tax_number\": \"52998224725\"\n  }\n}")

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

	req.Header.Add("Trio-Version", "<trio-version>")
	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.trio.com.br/v2/out/darf/check")
  .header("Trio-Version", "<trio-version>")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accumulated_revenue_amount\": {\n    \"amount\": 0,\n    \"currency\": \"BRL\"\n  },\n  \"amount\": {\n    \"amount\": 13208,\n    \"currency\": \"BRL\"\n  },\n  \"assessment_date\": \"2026-01-01\",\n  \"authentication_date\": \"2026-01-30\",\n  \"due_date\": \"2026-01-30\",\n  \"federal_revenue_id\": \"473\",\n  \"fine_amount\": {\n    \"amount\": 1001,\n    \"currency\": \"BRL\"\n  },\n  \"interest_amount\": {\n    \"amount\": 1001,\n    \"currency\": \"BRL\"\n  },\n  \"percentage\": 0,\n  \"phone\": \"+5541999381724\",\n  \"reference_number\": null,\n  \"taxpayer\": {\n    \"name\": \"John Doe\",\n    \"tax_number\": \"52998224725\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.trio.com.br/v2/out/darf/check")

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

request = Net::HTTP::Post.new(url)
request["Trio-Version"] = '<trio-version>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accumulated_revenue_amount\": {\n    \"amount\": 0,\n    \"currency\": \"BRL\"\n  },\n  \"amount\": {\n    \"amount\": 13208,\n    \"currency\": \"BRL\"\n  },\n  \"assessment_date\": \"2026-01-01\",\n  \"authentication_date\": \"2026-01-30\",\n  \"due_date\": \"2026-01-30\",\n  \"federal_revenue_id\": \"473\",\n  \"fine_amount\": {\n    \"amount\": 1001,\n    \"currency\": \"BRL\"\n  },\n  \"interest_amount\": {\n    \"amount\": 1001,\n    \"currency\": \"BRL\"\n  },\n  \"percentage\": 0,\n  \"phone\": \"+5541999381724\",\n  \"reference_number\": null,\n  \"taxpayer\": {\n    \"name\": \"John Doe\",\n    \"tax_number\": \"52998224725\"\n  }\n}"

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

{
  "data": {
    "accumulated_revenue_amount": {
      "amount": 0,
      "currency": "BRL"
    },
    "amount": {
      "amount": 13208,
      "currency": "BRL"
    },
    "assessment_date": "2022-11-04",
    "authentication_date": "2022-11-04",
    "due_date": "2022-11-04",
    "federal_revenue_id": "473",
    "fine_amount": {
      "amount": 1001,
      "currency": "BRL"
    },
    "id": "019cdabf-5a3e-7c21-9f10-2b6d8e4c1a77",
    "inserted_at": "2026-03-11T02:34:58.120000Z",
    "interest_amount": {
      "amount": 1001,
      "currency": "BRL"
    },
    "percentage": 0,
    "reference_number": null,
    "taxpayer": {
      "name": "John Doe",
      "tax_number": "***982247**"
    },
    "type": "darf",
    "updated_at": "2026-03-11T02:34:58.120000Z"
  }
}

{
  "error": {
    "error_code": "INVALID_PARAMETER",
    "error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
    "errors": [
      {
        "field": "/amount",
        "message": "Invalid integer. Got: string"
      }
    ]
  }
}

{
  "error": {
    "error_code": "INVALID_PARAMETER",
    "error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
    "errors": [
      {
        "field": "/amount",
        "message": "Invalid integer. Got: string"
      }
    ]
  }
}

{
  "error": {
    "error_code": "INVALID_PARAMETER",
    "error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
    "errors": [
      {
        "field": "/amount",
        "message": "Invalid integer. Got: string"
      }
    ]
  }
}

{
  "error": {
    "error_code": "INVALID_PARAMETER",
    "error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
    "errors": [
      {
        "field": "/amount",
        "message": "Invalid integer. Got: string"
      }
    ]
  }
}

{
  "error": {
    "error_code": "INVALID_PARAMETER",
    "error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
    "errors": [
      {
        "field": "/amount",
        "message": "Invalid integer. Got: string"
      }
    ]
  }
}

POST

out

darf

check

Check DARF

curl --request POST \
  --url https://api.sandbox.trio.com.br/v2/out/darf/check \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'Trio-Version: <trio-version>' \
  --data '
{
  "accumulated_revenue_amount": {
    "amount": 0,
    "currency": "BRL"
  },
  "amount": {
    "amount": 13208,
    "currency": "BRL"
  },
  "assessment_date": "2026-01-01",
  "authentication_date": "2026-01-30",
  "due_date": "2026-01-30",
  "federal_revenue_id": "473",
  "fine_amount": {
    "amount": 1001,
    "currency": "BRL"
  },
  "interest_amount": {
    "amount": 1001,
    "currency": "BRL"
  },
  "percentage": 0,
  "phone": "+5541999381724",
  "reference_number": null,
  "taxpayer": {
    "name": "John Doe",
    "tax_number": "52998224725"
  }
}
'

import requests

url = "https://api.sandbox.trio.com.br/v2/out/darf/check"

payload = {
    "accumulated_revenue_amount": {
        "amount": 0,
        "currency": "BRL"
    },
    "amount": {
        "amount": 13208,
        "currency": "BRL"
    },
    "assessment_date": "2026-01-01",
    "authentication_date": "2026-01-30",
    "due_date": "2026-01-30",
    "federal_revenue_id": "473",
    "fine_amount": {
        "amount": 1001,
        "currency": "BRL"
    },
    "interest_amount": {
        "amount": 1001,
        "currency": "BRL"
    },
    "percentage": 0,
    "phone": "+5541999381724",
    "reference_number": None,
    "taxpayer": {
        "name": "John Doe",
        "tax_number": "52998224725"
    }
}
headers = {
    "Trio-Version": "<trio-version>",
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Trio-Version': '<trio-version>',
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    accumulated_revenue_amount: {amount: 0, currency: 'BRL'},
    amount: {amount: 13208, currency: 'BRL'},
    assessment_date: '2026-01-01',
    authentication_date: '2026-01-30',
    due_date: '2026-01-30',
    federal_revenue_id: '473',
    fine_amount: {amount: 1001, currency: 'BRL'},
    interest_amount: {amount: 1001, currency: 'BRL'},
    percentage: 0,
    phone: '+5541999381724',
    reference_number: null,
    taxpayer: {name: 'John Doe', tax_number: '52998224725'}
  })
};

fetch('https://api.sandbox.trio.com.br/v2/out/darf/check', 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.sandbox.trio.com.br/v2/out/darf/check",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'accumulated_revenue_amount' => [
        'amount' => 0,
        'currency' => 'BRL'
    ],
    'amount' => [
        'amount' => 13208,
        'currency' => 'BRL'
    ],
    'assessment_date' => '2026-01-01',
    'authentication_date' => '2026-01-30',
    'due_date' => '2026-01-30',
    'federal_revenue_id' => '473',
    'fine_amount' => [
        'amount' => 1001,
        'currency' => 'BRL'
    ],
    'interest_amount' => [
        'amount' => 1001,
        'currency' => 'BRL'
    ],
    'percentage' => 0,
    'phone' => '+5541999381724',
    'reference_number' => null,
    'taxpayer' => [
        'name' => 'John Doe',
        'tax_number' => '52998224725'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json",
    "Trio-Version: <trio-version>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.sandbox.trio.com.br/v2/out/darf/check"

	payload := strings.NewReader("{\n  \"accumulated_revenue_amount\": {\n    \"amount\": 0,\n    \"currency\": \"BRL\"\n  },\n  \"amount\": {\n    \"amount\": 13208,\n    \"currency\": \"BRL\"\n  },\n  \"assessment_date\": \"2026-01-01\",\n  \"authentication_date\": \"2026-01-30\",\n  \"due_date\": \"2026-01-30\",\n  \"federal_revenue_id\": \"473\",\n  \"fine_amount\": {\n    \"amount\": 1001,\n    \"currency\": \"BRL\"\n  },\n  \"interest_amount\": {\n    \"amount\": 1001,\n    \"currency\": \"BRL\"\n  },\n  \"percentage\": 0,\n  \"phone\": \"+5541999381724\",\n  \"reference_number\": null,\n  \"taxpayer\": {\n    \"name\": \"John Doe\",\n    \"tax_number\": \"52998224725\"\n  }\n}")

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

	req.Header.Add("Trio-Version", "<trio-version>")
	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.trio.com.br/v2/out/darf/check")
  .header("Trio-Version", "<trio-version>")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accumulated_revenue_amount\": {\n    \"amount\": 0,\n    \"currency\": \"BRL\"\n  },\n  \"amount\": {\n    \"amount\": 13208,\n    \"currency\": \"BRL\"\n  },\n  \"assessment_date\": \"2026-01-01\",\n  \"authentication_date\": \"2026-01-30\",\n  \"due_date\": \"2026-01-30\",\n  \"federal_revenue_id\": \"473\",\n  \"fine_amount\": {\n    \"amount\": 1001,\n    \"currency\": \"BRL\"\n  },\n  \"interest_amount\": {\n    \"amount\": 1001,\n    \"currency\": \"BRL\"\n  },\n  \"percentage\": 0,\n  \"phone\": \"+5541999381724\",\n  \"reference_number\": null,\n  \"taxpayer\": {\n    \"name\": \"John Doe\",\n    \"tax_number\": \"52998224725\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.trio.com.br/v2/out/darf/check")

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

request = Net::HTTP::Post.new(url)
request["Trio-Version"] = '<trio-version>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accumulated_revenue_amount\": {\n    \"amount\": 0,\n    \"currency\": \"BRL\"\n  },\n  \"amount\": {\n    \"amount\": 13208,\n    \"currency\": \"BRL\"\n  },\n  \"assessment_date\": \"2026-01-01\",\n  \"authentication_date\": \"2026-01-30\",\n  \"due_date\": \"2026-01-30\",\n  \"federal_revenue_id\": \"473\",\n  \"fine_amount\": {\n    \"amount\": 1001,\n    \"currency\": \"BRL\"\n  },\n  \"interest_amount\": {\n    \"amount\": 1001,\n    \"currency\": \"BRL\"\n  },\n  \"percentage\": 0,\n  \"phone\": \"+5541999381724\",\n  \"reference_number\": null,\n  \"taxpayer\": {\n    \"name\": \"John Doe\",\n    \"tax_number\": \"52998224725\"\n  }\n}"

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

{
  "data": {
    "accumulated_revenue_amount": {
      "amount": 0,
      "currency": "BRL"
    },
    "amount": {
      "amount": 13208,
      "currency": "BRL"
    },
    "assessment_date": "2022-11-04",
    "authentication_date": "2022-11-04",
    "due_date": "2022-11-04",
    "federal_revenue_id": "473",
    "fine_amount": {
      "amount": 1001,
      "currency": "BRL"
    },
    "id": "019cdabf-5a3e-7c21-9f10-2b6d8e4c1a77",
    "inserted_at": "2026-03-11T02:34:58.120000Z",
    "interest_amount": {
      "amount": 1001,
      "currency": "BRL"
    },
    "percentage": 0,
    "reference_number": null,
    "taxpayer": {
      "name": "John Doe",
      "tax_number": "***982247**"
    },
    "type": "darf",
    "updated_at": "2026-03-11T02:34:58.120000Z"
  }
}

{
  "error": {
    "error_code": "INVALID_PARAMETER",
    "error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
    "errors": [
      {
        "field": "/amount",
        "message": "Invalid integer. Got: string"
      }
    ]
  }
}

{
  "error": {
    "error_code": "INVALID_PARAMETER",
    "error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
    "errors": [
      {
        "field": "/amount",
        "message": "Invalid integer. Got: string"
      }
    ]
  }
}

{
  "error": {
    "error_code": "INVALID_PARAMETER",
    "error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
    "errors": [
      {
        "field": "/amount",
        "message": "Invalid integer. Got: string"
      }
    ]
  }
}

{
  "error": {
    "error_code": "INVALID_PARAMETER",
    "error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
    "errors": [
      {
        "field": "/amount",
        "message": "Invalid integer. Got: string"
      }
    ]
  }
}

{
  "error": {
    "error_code": "INVALID_PARAMETER",
    "error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
    "errors": [
      {
        "field": "/amount",
        "message": "Invalid integer. Got: string"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

Trio-Version

enum<string>

required

Version of the v2 contract the client is written against. Each breaking change publishes a new version.

Available options:

2026-10-19.v2

Trio-Target-Org-Id

string<uuid>

ID of another org to act on instead of the API key's own org. The key's org must have been granted access to it, and the request is refused with 403 FORBIDDEN otherwise. When that access or the API key is read-only, only GET and HEAD requests may carry it. When the target org requires mTLS, so does the request. Leave it out to act on the key's own org.

Body

application/json

Check DARF payload

The DARF to check, as the check response publishes it. A DARF is always paid to Receita Federal, so it has a taxpayer and no beneficiary.

accumulated_revenue_amount

V2 DARF money · object

required

An amount of a DARF

Show child attributes

Example:

{ "amount": 1001, "currency": "BRL" }

amount

V2 DARF money · object

required

An amount of a DARF

Show child attributes

Example:

{ "amount": 1001, "currency": "BRL" }

assessment_date

string<date>

required

Assessment period (período de apuração)

authentication_date

string<date>

required

Authentication date

due_date

string<date>

required

Due date

federal_revenue_id

string

required

Revenue code (código da receita)

fine_amount

V2 DARF money · object

required

An amount of a DARF

Show child attributes

Example:

{ "amount": 1001, "currency": "BRL" }

interest_amount

V2 DARF money · object

required

An amount of a DARF

Show child attributes

Example:

{ "amount": 1001, "currency": "BRL" }

percentage

integer

required

Percentage

phone

string

required

Taxpayer phone number

taxpayer

object

required

Taxpayer the DARF belongs to

Show child attributes

reference_number

integer | null

Reference number

Response

Check

A DARF checked before it is paid. A DARF is always paid to Receita Federal, so it has a taxpayer and no beneficiary.

data

object

Show child attributes