Complete a BYOK Model-A signing-key import (SaaS)

curl --request POST \
  --url https://slc.sandbox.lerian.net/v1/signing-key \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "encryptedKeyMaterialBase64": "<string>",
  "importTokenBase64": "<string>",
  "keyId": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "participantIspb": "29011780",
  "publicCertPem": "<string>"
}
'

package main

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

func main() {

	url := "https://slc.sandbox.lerian.net/v1/signing-key"

	payload := strings.NewReader("{\n  \"encryptedKeyMaterialBase64\": \"<string>\",\n  \"importTokenBase64\": \"<string>\",\n  \"keyId\": \"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e\",\n  \"participantIspb\": \"29011780\",\n  \"publicCertPem\": \"<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({
    encryptedKeyMaterialBase64: '<string>',
    importTokenBase64: '<string>',
    keyId: '018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e',
    participantIspb: '29011780',
    publicCertPem: '<string>'
  })
};

fetch('https://slc.sandbox.lerian.net/v1/signing-key', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://slc.sandbox.lerian.net/v1/signing-key"

payload = {
    "encryptedKeyMaterialBase64": "<string>",
    "importTokenBase64": "<string>",
    "keyId": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
    "participantIspb": "29011780",
    "publicCertPem": "<string>"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "certificateId": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "kmsRef": "arn:aws:kms:us-east-1:000000000000:key/018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "status": "imported"
}

{
  "correlationId": "req-7a3f9c2e",
  "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"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "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"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "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"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "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"
  }
}

Complete a BYOK Model-A signing-key import (SaaS)

Forwards the tenant’s already-wrapped, opaque key material (Model A — never cleartext) to KMS via the signer sidecar, then persists ONLY the public certificate + the per-tenant KMS reference + custody_provider=KMS (never key material). RBAC: signing-key:import (admin-only provisioning role). Field presence/type is validated against the schema (422); a malformed ISPB or invalid base64 is a coded 400. Idempotent via the MANDATORY X-Idempotency header.

POST

signing-key

curl --request POST \
  --url https://slc.sandbox.lerian.net/v1/signing-key \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "encryptedKeyMaterialBase64": "<string>",
  "importTokenBase64": "<string>",
  "keyId": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "participantIspb": "29011780",
  "publicCertPem": "<string>"
}
'

package main

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

func main() {

	url := "https://slc.sandbox.lerian.net/v1/signing-key"

	payload := strings.NewReader("{\n  \"encryptedKeyMaterialBase64\": \"<string>\",\n  \"importTokenBase64\": \"<string>\",\n  \"keyId\": \"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e\",\n  \"participantIspb\": \"29011780\",\n  \"publicCertPem\": \"<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({
    encryptedKeyMaterialBase64: '<string>',
    importTokenBase64: '<string>',
    keyId: '018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e',
    participantIspb: '29011780',
    publicCertPem: '<string>'
  })
};

fetch('https://slc.sandbox.lerian.net/v1/signing-key', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://slc.sandbox.lerian.net/v1/signing-key"

payload = {
    "encryptedKeyMaterialBase64": "<string>",
    "importTokenBase64": "<string>",
    "keyId": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
    "participantIspb": "29011780",
    "publicCertPem": "<string>"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "certificateId": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "kmsRef": "arn:aws:kms:us-east-1:000000000000:key/018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "status": "imported"
}

{
  "correlationId": "req-7a3f9c2e",
  "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"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "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"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "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"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "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 safe retries (MANDATORY on this high-sensitivity endpoint).

Ejemplo:

"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e"

Cuerpo

application/json

encryptedKeyMaterialBase64

string

requerido

Base64-encoded wrapped private-key material (Model A — never cleartext).

Minimum string length: 1

importTokenBase64

string

requerido

Base64-encoded opaque KMS import token from the import-params step.

Minimum string length: 1

keyId

string

requerido

KMS key id returned by the import-params step.

Minimum string length: 1

Ejemplo:

"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e"

participantIspb

string

requerido

Participant ISPB the certificate belongs to (8-character identifier).

Minimum string length: 1

Ejemplo:

"29011780"

publicCertPem

string

requerido

PEM-encoded PUBLIC ICP-Brasil server-type certificate. Refused unless the key is RSA of at least 2048 bits and the certificate is valid right now (MAPX-OP106 §8.3.1 vii, §8.4).

Minimum string length: 1

Respuesta

certificateId

string

requerido

Stored public-certificate id.

Ejemplo:

"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e"

kmsRef

string

requerido

Per-tenant KMS key reference.

Ejemplo:

"arn:aws:kms:us-east-1:000000000000:key/018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e"

status

string

requerido

Import result status.

Ejemplo:

"imported"

Administración

Compensación

Grilla de liquidación

Fondeo

LBTR

Conectividad

Operaciones

Archivos

Participantes

Acuerdos

Informes

Claves de firma

Esquemas XSD

Webhooks

Manejo de errores

Complete a BYOK Model-A signing-key import (SaaS)

Autorizaciones

Encabezados

Cuerpo

Respuesta