Get a return file's decrypted content (dev-only) - Lerian

Get a return file's decrypted content (dev-only)

curl --request GET \
  --url https://sisbajud.sandbox.lerian.net/admin/return-file/{id}/content \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://sisbajud.sandbox.lerian.net/admin/return-file/{id}/content"

	req, _ := http.NewRequest("GET", 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))

}

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

fetch('https://sisbajud.sandbox.lerian.net/admin/return-file/{id}/content', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://sisbajud.sandbox.lerian.net/admin/return-file/{id}/content"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "content": "QkFOQ08gU0lTQkFKVUQgUkVUT1JOSw==",
  "environment": "production",
  "fileHash": "sha256:abc123...",
  "fileName": "retorno-2026-07-14.txt",
  "fileType": "RETORNO",
  "generationDate": "2026-07-14T12:00:00Z",
  "id": "dddddddd-dddd-dddd-dddd-dddddddddddd",
  "institutionCode": "01234567000189",
  "recordCount": 42,
  "status": "GENERATED",
  "transmissionDate": "2026-07-14T13:00:00Z"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

GET

/

admin

/

return-file

/

{id}

/

content

Get a return file's decrypted content (dev-only)

curl --request GET \
  --url https://sisbajud.sandbox.lerian.net/admin/return-file/{id}/content \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://sisbajud.sandbox.lerian.net/admin/return-file/{id}/content"

	req, _ := http.NewRequest("GET", 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))

}

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

fetch('https://sisbajud.sandbox.lerian.net/admin/return-file/{id}/content', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://sisbajud.sandbox.lerian.net/admin/return-file/{id}/content"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "content": "QkFOQ08gU0lTQkFKVUQgUkVUT1JOSw==",
  "environment": "production",
  "fileHash": "sha256:abc123...",
  "fileName": "retorno-2026-07-14.txt",
  "fileType": "RETORNO",
  "generationDate": "2026-07-14T12:00:00Z",
  "id": "dddddddd-dddd-dddd-dddd-dddddddddddd",
  "institutionCode": "01234567000189",
  "recordCount": 42,
  "status": "GENERATED",
  "transmissionDate": "2026-07-14T13:00:00Z"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

id

string

requerido

The return file id (UUID).

Ejemplo:

"dddddddd-dddd-dddd-dddd-dddddddddddd"

Respuesta

OK

content

string

requerido

The base64-encoded decrypted return-file body.

Ejemplo:

"QkFOQ08gU0lTQkFKVUQgUkVUT1JOSw=="

environment

string

requerido

The resolved SISBAJUD environment.

Ejemplo:

"production"

fileHash

string

requerido

The file content hash.

Ejemplo:

"sha256:abc123..."

fileName

string

requerido

The file name.

Ejemplo:

"retorno-2026-07-14.txt"

fileType

string

requerido

The SISBAJUD file-type code.

Ejemplo:

"RETORNO"

generationDate

string

requerido

The RFC3339 generation timestamp.

Ejemplo:

"2026-07-14T12:00:00Z"

id

string

requerido

The return file id.

Ejemplo:

"dddddddd-dddd-dddd-dddd-dddddddddddd"

institutionCode

string

requerido

The filing institution code (BACEN CNPJ).

Ejemplo:

"01234567000189"

recordCount

integer<int64>

requerido

The number of records in the file.

Ejemplo:

42

status

string

requerido

The file status.

Ejemplo:

"GENERATED"

transmissionDate

string

The RFC3339 transmission timestamp, when transmitted.

Ejemplo:

"2026-07-14T13:00:00Z"