Get the Dataprev credential status

curl --request GET \
  --url https://consignado.sandbox.lerian.net/v1/credentials/dataprev \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://consignado.sandbox.lerian.net/v1/credentials/dataprev"

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

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

print(response.text)

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

fetch('https://consignado.sandbox.lerian.net/v1/credentials/dataprev', 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://consignado.sandbox.lerian.net/v1/credentials/dataprev",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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://consignado.sandbox.lerian.net/v1/credentials/dataprev"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://consignado.sandbox.lerian.net/v1/credentials/dataprev")

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

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

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

{
  "certPresent": true,
  "oauthPresent": true,
  "provider": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "certFingerprint": "<string>",
  "certNotAfter": "2023-11-07T05:31:56Z",
  "codigoSolicitante": "<string>",
  "revokedAt": "2023-11-07T05:31:56Z",
  "taxaMensal": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank",
  "upstream": {
    "code": "<string>",
    "message": "<string>"
  }
}

GET

credentials

dataprev

Get the Dataprev credential status

curl --request GET \
  --url https://consignado.sandbox.lerian.net/v1/credentials/dataprev \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://consignado.sandbox.lerian.net/v1/credentials/dataprev"

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

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

print(response.text)

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

fetch('https://consignado.sandbox.lerian.net/v1/credentials/dataprev', 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://consignado.sandbox.lerian.net/v1/credentials/dataprev",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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://consignado.sandbox.lerian.net/v1/credentials/dataprev"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://consignado.sandbox.lerian.net/v1/credentials/dataprev")

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

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

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

{
  "certPresent": true,
  "oauthPresent": true,
  "provider": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "certFingerprint": "<string>",
  "certNotAfter": "2023-11-07T05:31:56Z",
  "codigoSolicitante": "<string>",
  "revokedAt": "2023-11-07T05:31:56Z",
  "taxaMensal": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank",
  "upstream": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Response

certPresent

boolean

required

Whether a client certificate is stored for the tenant.

oauthPresent

boolean

required

Whether OAuth2 client_credentials are stored for the tenant.

provider

string

required

External rail the credentials belong to.

Example:

"dataprev"

updatedAt

string<date-time>

required

Last-update timestamp (RFC 3339, UTC).

Example:

"2026-06-23T12:00:00Z"

certFingerprint

string

SHA-256 hex fingerprint of the stored certificate (absent when none).

Example:

"3b1f...c0"

certNotAfter

string<date-time>

RFC 3339 cert expiry (UTC); absent when no cert is stored.

Example:

"2027-01-01T00:00:00Z"

codigoSolicitante

string

Dataprev codigoSolicitante: the institution's BACEN COMPE code (3 digits, zero-padded, 001-999). Public, non-secret; absent when none is stored.

Example:

"341"

revokedAt

string<date-time>

Credential revocation timestamp (RFC 3339, UTC); absent when credentials were never revoked.

Example:

"2026-07-14T15:30:00Z"

taxaMensal

string

Configured monthly interest rate for consignado bids, as a PERCENT-per-month decimal (1.80 is 1,80% per month). Commercial configuration, non-secret; absent when none is stored, in which case the gateway places no bid.

Example:

"1.80"

⌘I

Pix — Lerian SPI (native messaging)

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado (native messaging)

Get the Dataprev credential status

Authorizations

Response