CAcardda
SII Key

Retrieve one

Returns a single SII key by id. Sensitive credential fields (password, certificate_password) are stripped; the response includes the computed can_issue? and company_ids fields.

get/v1/sii/keys/{sii_key_id}

Request

  • Base URL
    https://api.cardda.com
  • URL
    https://api.cardda.com/v1/sii/keys/{sii_key_id}
  • Auth
    HTTP bearer

Path parameters

sii_key_idstring uuid required

UUID of the SII key (digital-certificate credential).

Parameters

#/paths/~1v1~1sii~1keys/get/parameters/0 (unresolved $ref)

Response

The requested SII key.

idstring uuid required

UUID of the SII key.

rutstring required

Tax id (RUT) the certificate belongs to, stored as bare digits plus the verifier digit (e.g. 761234567 or 12345678K). Unique across all SII keys.

user_idstring nullable

Firebase user id of the person who provided the credential.

status'approved' | 'pending' | 'canceled' | 'declined' required

Lifecycle status of the credential.

ValueMeaning
pendingJust created; Cardda has not yet validated it against the SII.
approvedValidated; the key can sync companies and invoices.
declinedThe SII rejected the credentials (auth/wrong-credentials).
canceledThe credential was disabled.
issuer_phoneinteger nullable

Phone number registered for the issuer, when captured.

last_synced_atstring date-time nullable

Timestamp of the last successful invoice/company sync.

can_issueboolean

Whether the key can issue electronic documents — true when status is approved and a certificate password is present. Note: this field is serialized with a trailing question mark in the JSON response (can_issue?).

company_idsstring[]

UUIDs of the companies this key manages (resolved through the SII managers join). Present on the list and detail responses; omitted from the update response.

created_atstring date-time

When the key was created in Cardda.

updated_atstring date-time

When the key was last updated.

Changes

No recorded changes to this operation across all 1 revision of this API.