How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tvarka ATK API Sign API

The QES signing ceremony (`/v1/sign/*`).

Tvarka ATK API Sign API is one of 10 APIs that Tvarka ATK API publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sign. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 8 operations across 8 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version 1.3.0.

Requests are made against a single base URL, https://atk.tvarka.pro/v1.

8 operations 8 paths 27 schemas 3 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.3.0
Base URL
https://atk.tvarka.pro/v1
Authentication
HTTP Basic, HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 3

Tvarka ATK API Sign API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (JWT) (clientToken). An API key is passed in the query as downloadToken (downloadToken). By default, every request must be authenticated.

  • basicAuth — Provider server-to-server credentials keyId:keySecret. Server-to-server only, also gated by the provider's server IP allow-list. Never placed in a browser/mobi…
  • clientToken — Short-lived, per-request JWT (ES256) minted at request creation, scoped {tenant, requestId, purpose, method, allowedOrigins}. Safe to hand to a browser/mobile…
  • downloadToken — One-off token returned with a completed sign result, for fetching the signed document.

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 3 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Sign 8

The QES signing ceremony (/v1/sign/).

POST
/sign/requests
Create a signing request (server-to-server)
createSignRequest body → 202400401403413429503
POST
/sign/{requestId}/certificate
Submit the card's signing certificate; receive the DTBS
submitSignCertificate 1 param body → 200401403404409422
POST
/sign/{requestId}/complete
Submit the raw card signature; assemble the container
completeSign 1 param body → 200401404409422
GET
/sign/{requestId}
Poll status + validation axis; fetch the result
getSignRequest 1 param → 200401404
GET
/sign/{requestId}/document
Download the signed container
downloadSignedDocument 1 param → 200401404
POST
/sign/{requestId}/cancel
Cancel a non-terminal request
cancelSignRequest 1 param → 200404409
GET
/sign/{requestId}/pairing
Rotate and return the NFC pairing token for a sign request
getSignPairing 1 param → 200404409
POST
/pairing/claim
Atomically claim an auth or sign NFC pairing
claimPairing body → 200404409429

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are SignSignRequestState (10 properties), PairingClaimResponse (7 properties), SignSignResult (7 properties), SignSignRequestCreated (7 properties). Each schema is shown below with its type and property counts.

SignErrorCode
string
The full stable error-code catalog of the ATK API family (auth + sign + services); each endpoint returns the subset that applies to it. By HTTP status: 400 inv…
SignCertSubject
object
5 properties
SignValidation
object
The advisory validation axis. Independent of status. See the two-axes note.
3 properties 1 required
ErrorBody
object
4 properties 2 required
SignPairingHint
object
3 properties
SignSignRequestCreated
object
Physical requests return clientToken; NFC returns pairing; remote methods return neither.
7 properties 5 required
Error
object
1 property 1 required
SignSignCompleteSubmit
object
4 properties 3 required
SignSignatureAlgorithm
string
SignFormat
string
pades = signed PDF; asice/adoc = XAdES-T containers; raw = a detached CAdES package from a bare hash (no container returned). Container formats require documen…
SignSignCertificateChallenge
object
7 properties 6 required
SignSignResult
object
7 properties 4 required
SignSignRequestState
object
10 properties 3 required
ErrorCode
string
The full stable error-code catalog of the ATK API family (auth + sign + services); each endpoint returns the subset that applies to it. By HTTP status: 400 inv…
SignStatus
string
Non-terminal - pending/awaitingCard/awaitingCredentials/finalizing. Terminal success - done. Terminal failure - cancelled/timeout/deviceError/pinBlocked/cardRe…
PairingClaimRequest
object
3 properties 1 required
SignErrorBody
object
4 properties 2 required
SignHashAlgOid
string
SHA-256 / SHA-384 OID, curve-matched.
SignPairingInfo
Status
string
Non-terminal - pending/awaitingCard/awaitingCredentials/finalizing. Terminal success - done. Terminal failure - cancelled/timeout/deviceError/pinBlocked/cardRe…
SignSignCertificateSubmit
object
1 property 1 required
SignMethod
string
physical/NFC use card endpoints; smartid/mobileid complete server-side and support PAdES only.
SignSignRequestCreate
ATK supports every listed format; Smart-ID/Mobile-ID support PAdES only.
SignSignatureEncoding
string
Informational - the server auto-detects and accepts either encoding regardless of this field.
SignDocumentRef
object
Backend-fetched document. Hard SSRF controls apply - HTTPS only, host allow-list, no private/loopback/link-local, DNS-rebind protection, size cap enforced pre…
4 properties 3 required
PairingClaimResponse
object
7 properties 7 required
SignError
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tvarka-atk-api-sign-api-openapi.yml Raw ↑

Other APIs Tvarka ATK API publishes across the network.

Tvarka ATK API Auth API
Tvarka ATK API Erasure API
Tvarka ATK API LTV API
Tvarka ATK API Pairing API
Tvarka ATK API Tvarka ATK API API
Tvarka ATK API Tvarka ATK QES Signing API (paid Tier Addendum) API
Tvarka ATK API Validation API
Tvarka ATK API Well Known API
Tvarka Sign API
Where this information came from

This is an independent, third-party profile of Tvarka ATK API Sign API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.