Get a certificate

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 a certificate

curl --request GET \
  --url http://localhost:9820/api/v1/siloc/certificates/{certificateId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "http://localhost:9820/api/v1/siloc/certificates/{certificateId}"

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

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

print(response.text)

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

fetch('http://localhost:9820/api/v1/siloc/certificates/{certificateId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "9820",
  CURLOPT_URL => "http://localhost:9820/api/v1/siloc/certificates/{certificateId}",
  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 := "http://localhost:9820/api/v1/siloc/certificates/{certificateId}"

	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("http://localhost:9820/api/v1/siloc/certificates/{certificateId}")

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

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

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

{
  "daysToExpiry": 123,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "notAfter": "2023-11-07T05:31:56Z",
  "sfnCertificateId": "<string>",
  "subject": "<string>",
  "custodyReference": "<string>",
  "notBefore": "2023-11-07T05:31:56Z",
  "revokedAt": "2023-11-07T05:31:56Z",
  "serialNumber": "<string>"
}

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

GET

api

siloc

certificates

{certificateId}

Get a certificate

curl --request GET \
  --url http://localhost:9820/api/v1/siloc/certificates/{certificateId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "http://localhost:9820/api/v1/siloc/certificates/{certificateId}"

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

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

print(response.text)

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

fetch('http://localhost:9820/api/v1/siloc/certificates/{certificateId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "9820",
  CURLOPT_URL => "http://localhost:9820/api/v1/siloc/certificates/{certificateId}",
  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 := "http://localhost:9820/api/v1/siloc/certificates/{certificateId}"

	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("http://localhost:9820/api/v1/siloc/certificates/{certificateId}")

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

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

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

{
  "daysToExpiry": 123,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "notAfter": "2023-11-07T05:31:56Z",
  "sfnCertificateId": "<string>",
  "subject": "<string>",
  "custodyReference": "<string>",
  "notBefore": "2023-11-07T05:31:56Z",
  "revokedAt": "2023-11-07T05:31:56Z",
  "serialNumber": "<string>"
}

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

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Path Parameters

certificateId

string<uuid>

required

Certificate id.

Response

daysToExpiry

integer<int64>

required

Whole days until expiry (0 the day it lapses, negative once expired). Always present — a real 0 is the most urgent operator signal.

string<uuid>

required

Certificate id.

notAfter

string<date-time>

required

Validity end (expiry).

sfnCertificateId

string

required

Exact 64-hex C11 identity used on the SFN wire.

subject

string

required

Certificate subject DN.

Example:

"CN=46026562, OU=SILOC"

custodyReference

string

Opaque reference to the private key in the FI's custody; the key itself is never stored here.

notBefore

string<date-time>

Validity start.

revokedAt

string<date-time>

Revocation time. Omitted while the certificate is active.

serialNumber

string

Certificate serial number.

⌘I