Register a certificate reference

curl --request POST \
  --url https://api.example.com/api/v1/siloc/certificates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "custodyReference": "<string>",
  "publicCertificatePem": "<string>",
  "sfnCertificateId": "<string>"
}
'

package main

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

func main() {

	url := "https://api.example.com/api/v1/siloc/certificates"

	payload := strings.NewReader("{\n  \"custodyReference\": \"<string>\",\n  \"publicCertificatePem\": \"<string>\",\n  \"sfnCertificateId\": \"<string>\"\n}")

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

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("Authorization", "Bearer <token>")
	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))

}

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    custodyReference: '<string>',
    publicCertificatePem: '<string>',
    sfnCertificateId: '<string>'
  })
};

fetch('https://api.example.com/api/v1/siloc/certificates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/v1/siloc/certificates"

payload = {
    "custodyReference": "<string>",
    "publicCertificatePem": "<string>",
    "sfnCertificateId": "<string>"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

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

{
  "code": "<string>",
  "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"
  }
}

{
  "code": "<string>",
  "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"
  }
}

{
  "code": "<string>",
  "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"
  }
}

POST

api

siloc

certificates

curl --request POST \
  --url https://api.example.com/api/v1/siloc/certificates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "custodyReference": "<string>",
  "publicCertificatePem": "<string>",
  "sfnCertificateId": "<string>"
}
'

package main

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

func main() {

	url := "https://api.example.com/api/v1/siloc/certificates"

	payload := strings.NewReader("{\n  \"custodyReference\": \"<string>\",\n  \"publicCertificatePem\": \"<string>\",\n  \"sfnCertificateId\": \"<string>\"\n}")

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

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("Authorization", "Bearer <token>")
	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))

}

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    custodyReference: '<string>',
    publicCertificatePem: '<string>',
    sfnCertificateId: '<string>'
  })
};

fetch('https://api.example.com/api/v1/siloc/certificates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/v1/siloc/certificates"

payload = {
    "custodyReference": "<string>",
    "publicCertificatePem": "<string>",
    "sfnCertificateId": "<string>"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

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

{
  "code": "<string>",
  "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"
  }
}

{
  "code": "<string>",
  "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"
  }
}

{
  "code": "<string>",
  "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.

Encabezados

X-Idempotency

string

requerido

Idempotency key for this state-changing request (required, max 255 characters).

Maximum string length: 255

Cuerpo

application/json

custodyReference

string

requerido

Reference locating the private key in the FI's custody (HSM/KMIP).

publicCertificatePem

string

requerido

PEM-encoded public certificate. The private key is NOT transmitted.

sfnCertificateId

string

requerido

Exact 64-hex C11 identity assigned to this certificate: the hex encoding of the 32-byte slot, whose content is the certificate serial in uppercase ASCII hex, right-aligned and zero-left-padded. No ISPB. Unique only within the authority derived from the certificate.

Required string length: 64

Respuesta

Created

authorityCode

integer<int64>

requerido

BACEN certificate-authority code (C10/C12 on the SFN wire): 1 SPB-Serpro, 2 SPB-Certisign, 3 Pessoas Fisicas, 4 SPB-Serasa, 5 SPB-CAIXA, 6 SPB-Valid, 7 SPB-Soluti. Derived from the certificate's own ISSUER block (OU=CSPB-N), never supplied. sfnCertificateId is unique only WITHIN this authority, so the two together are the identity.

daysToExpiry

integer<int64>

requerido

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>

requerido

Certificate id.

notAfter

string<date-time>

requerido

Validity end (expiry).

sfnCertificateId

string

requerido

Exact 64-hex C11 identity used on the SFN wire: the hex encoding of the 32-byte slot, whose content is the certificate serial in uppercase ASCII hex, right-aligned and zero-left-padded. No ISPB. Unique only within authorityCode.

subject

string

requerido

Certificate subject DN.

Ejemplo:

"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.

Integración

Conectividad

Homologación

Participantes

Ciclos y liquidación

Transferencias

Garantías

Ruta de tarjetas

Asientos y extractos

Avisos y notificaciones

Alertas y auditoría

Programación

Manejo de errores

Register a certificate reference

Autorizaciones

Encabezados

Cuerpo

Respuesta