Docs

Store a credential, encrypted; the value is never returned

  • In the sandbox

In plain words

Stores a rail credential, encrypted. The value is never returned.
POST
/credentials

A process stores credentials for its own environment only. legal_entity ties one to the seller id it acts for (VAT id, NIP, SIREN or company id); an untagged one serves the client's other invoices. A client's admin key stores for its own client only.

Authorization

apiKey
headerAuthorizationBearer <token>

Send your key as a bearer token: Authorization: Bearer <your-api-key>. Health is the only call that needs no key.

Request body

application/json
  1. body
client*string

Optional with a client key

Match^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
route*string
Value in"PL-KSEF""RO-EFACTURA""PEPPOL""FR-PA""DE-XRECHNUNG"
kind*string
issued_by*string
issued_on*string
Formatdate
expires_on?string
Formatdate
environment?string

Must be this process's environment; that is the default.

Value in"sandbox""production"
legal_entity?string
Lengthlength <= 64
value*string

Response body

Stored.

application/json
  1. response
id?string
client?string
route?string
kind?string
issued_by?string
issued_on?string
expires_on?string
environment?|

sandbox or production; null for a credential stored before 3 Oct 2026, which only a sandbox uses.

legal_entity?string
revoked_at?string
stored?boolean
curl -X POST "https://example.com/credentials" \  -H "Authorization: Bearer <your-api-key>" \  -H "Content-Type: application/json" \  -d '{    "client": "string",    "route": "PL-KSEF",    "kind": "string",    "issued_by": "string",    "issued_on": "2019-08-24",    "value": "string"  }'
{  "id": "string",  "client": "string",  "route": "string",  "kind": "string",  "issued_by": "string",  "issued_on": "string",  "expires_on": "string",  "environment": "string",  "legal_entity": "string",  "revoked_at": "string",  "stored": true}