# Vilna VKS API

Coordinate signer nodes, vault approval rules, blockchain account setup and transaction signing within a workspace. A complete signed transaction can optionally be submitted to a blockchain node; node acceptance does not mean blockchain confirmation.
See the [VKS overview](https://docs.vilna.io/apis/vks) for capabilities and lifecycle rules, the [Dashboard guide](https://docs.vilna.io/guides/vks) for first use, and [idempotency](https://docs.vilna.io/apis/idempotency) for mutation retries. Each operation and schema describes its transaction parameters, results and restrictions.

Version: 1.0.0
License: Proprietary

## Servers

```
https://vks.vilna.io/v1
```

## Security

### Auth

VKS key (`vilna_vks_...`). Each request is scoped to the workspace associated with the key. The key must have the `vks:access` permission.

Type: apiKey
In: header
Name: X-Api-Key

## Download OpenAPI description

 - [Vilna VKS API](https://docs.vilna.io/_bundle/@l10n/ru/apis/vks/api.yaml)

## limits

 - [GET /limits](https://docs.vilna.io/ru/apis/vks/api/limits/get-limits.md): Get signer usage and the effective limit for the current workspace.
## info

 - [GET /info](https://docs.vilna.io/ru/apis/vks/api/info/get-info.md): Get the hub identity and fingerprint to compare during signer registration.
## signer

 - [GET /signers/{signer_id}](https://docs.vilna.io/ru/apis/vks/api/signer/get-signer.md): Get signer registration and connection details. The name, fingerprints and public keys become available during registration. Compare fingerprints with the signer before trusting its identity. Returns
 - [DELETE /signers/{signer_id}](https://docs.vilna.io/ru/apis/vks/api/signer/delete-signer.md): Remove a signer or an unused invitation from the catalogue and revoke its access. The invitation token stops working. A registered signer can be removed only when it is no longer needed by an active v
 - [GET /signers](https://docs.vilna.io/ru/apis/vks/api/signer/list-signers.md): List signers with filtering, sorting and pagination. Names and identity details appear after registration. Deleted signers and registration tokens are not included.
 - [POST /signers](https://docs.vilna.io/ru/apis/vks/api/signer/create-signer.md): Invite a signer and receive a registration token, available only in the creation response or its short-lived replay. The signer provides its own name and keys when it registers. The invitation deadlin
## vault

 - [POST /vaults/{vault_id}/actions/abort](https://docs.vilna.io/ru/apis/vks/api/vault/abort-vault.md): Cancel a vault that is still waiting for signer acceptance. Active, rejected, expired and already cancelled vaults cannot be cancelled. Reuse the same Idempotency-Key with the same parameters when ret
 - [GET /vaults/{vault_id}](https://docs.vilna.io/ru/apis/vks/api/vault/get-vault.md): Get the vault configuration, signer acceptance status and available signing groups.
 - [GET /vaults](https://docs.vilna.io/ru/apis/vks/api/vault/list-vaults.md): List vaults with filtering, sorting and pagination.
 - [POST /vaults](https://docs.vilna.io/ru/apis/vks/api/vault/create-vault.md): Create a vault and request acceptance from its signers. Check the vault status while waiting for their responses. Registered signers may be selected even when offline; unregistered signers cannot part
## account

 - [POST /accounts/{account_id}/actions/abort](https://docs.vilna.io/ru/apis/vks/api/account/abort-account.md): Cancel account creation. Only accounts still being set up can be cancelled. Reuse the same Idempotency-Key with the same parameters when retrying this request. Current access is checked on every retry
 - [GET /accounts/{account_id}/certificate](https://docs.vilna.io/ru/apis/vks/api/account/get-account-certificate.md): Download the account certificate for verification. The item is null until the account becomes active and the certificate is available.
 - [GET /accounts/{account_id}](https://docs.vilna.io/ru/apis/vks/api/account/get-account.md): Get account details, including its address, public key and setup progress. Provide chain_gid to include the address with its blockchain identifier in caip10 once the account address is available.
 - [DELETE /accounts/{account_id}](https://docs.vilna.io/ru/apis/vks/api/account/delete-account.md): Delete an account whose creation failed, expired or was cancelled. Cancel an unfinished creation before deleting it. Active accounts cannot be deleted. Reuse the same Idempotency-Key with the same par
 - [GET /accounts](https://docs.vilna.io/ru/apis/vks/api/account/list-accounts.md): List accounts with filtering, sorting and pagination. Values within one filter match any value; different filters apply together. Only active accounts can sign transactions.
 - [POST /accounts](https://docs.vilna.io/ru/apis/vks/api/account/create-account.md): Create an account and start its setup automatically. The vault must be active, support the selected address format and have no other account being created. No further approval is needed; check the acc
## ceremony

 - [GET /ceremonies/{ceremony_id}](https://docs.vilna.io/ru/apis/vks/api/ceremony/get-ceremony-attempt.md): Get the progress and outcome of an account setup attempt. Attempt identifiers are available in the account attempts list.
## transaction

 - [POST /transactions/{transaction_id}/actions/send](https://docs.vilna.io/ru/apis/vks/api/transaction/send-transaction.md): Queue a signed transaction for submission to a blockchain node. The 202 response means the request was saved, not that the node accepted the transaction. Temporary failures and uncertain outcomes may
 - [GET /transactions/{transaction_id}/logs](https://docs.vilna.io/ru/apis/vks/api/transaction/list-transaction-logs.md): List send attempts for this transaction, newest first. Each entry describes one queued attempt to submit the signed transaction. A successful attempt means a node accepted it, not that it was confirme
 - [GET /transactions/{transaction_id}](https://docs.vilna.io/ru/apis/vks/api/transaction/get-transaction.md): Get transaction details, signer decisions and the signing status. The signed result and its hash become available when signing is complete.
 - [GET /transactions](https://docs.vilna.io/ru/apis/vks/api/transaction/list-transactions.md): List the account signing history with sorting and pagination, including signed results and any send time recorded by VKS.
 - [POST /transactions](https://docs.vilna.io/ru/apis/vks/api/transaction/create-transaction.md): Request approval and signing of a transaction. VKS assigns its transaction_id. Use an active account, a network supported by its address format, and one complete signing group from the vault. Supply t