Signatures

Drive a sandbox signature to an outcome

Sandbox keys only. sign returns your XML unchanged, or an empty .p7s placeholder for a hash, flagged sandbox: true and completionMode: sandbox_simulation: no signature is added. fail takes an optional reason from SignatureFailureReason.

post/v1/signatures/{signatureId}/simulate

Request

  • Base URL: https://sign-api.tvarka.pro
  • URL: https://sign-api.tvarka.pro/v1/signatures/{signatureId}/simulate
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key
    • OAuth 2 (authorization code, authorization URL https://sign-api.tvarka.pro/oauth/authorize, token URL https://sign-api.tvarka.pro/oauth/token, scopes: sign.read, sign.signings)

Path parameters

signatureIdstring uuid required

Request body

action'sign' | 'decline' | 'expire' | 'fail' required
reason'identity_mismatch' | 'certificate_not_qualified' | 'certificate_rotated' | 'provider_error' | 'timestamp_unavailable' | 'initiation_unknown'

identity_mismatch - the certificate belongs to another person. certificate_not_qualified - the certificate cannot sign documents. certificate_rotated - the signer's certificate changed since Tvarka last saw it; the new one is kept, so a retry needs one confirmation. provider_error - the signing service failed. timestamp_unavailable - no qualified timestamp could be obtained. initiation_unknown - the start may have reached the signer's phone but no answer came back; it is never repeated. Ask the signer to dismiss any prompt and retry after two minutes. None of these is billed.

Response

The signature after the simulated outcome.

idstring uuid required
status'pending' | 'signed' | 'declined' | 'expired' | 'failed' | 'cancelled' required
method'smart_id' | 'mobile_id' required
interaction'notification' | 'qr' | 'app_link'
step'authentication' | 'signing' required

The confirmation in flight. Tvarka decides which run.

verificationCodestring nullable

Show this to the signer while pending.

expiresAtstring date-time
externalIdstring nullable
failureReason'identity_mismatch' | 'certificate_not_qualified' | 'certificate_rotated' | 'provider_error' | 'timestamp_unavailable' | 'initiation_unknown'

identity_mismatch - the certificate belongs to another person. certificate_not_qualified - the certificate cannot sign documents. certificate_rotated - the signer's certificate changed since Tvarka last saw it; the new one is kept, so a retry needs one confirmation. provider_error - the signing service failed. timestamp_unavailable - no qualified timestamp could be obtained. initiation_unknown - the start may have reached the signer's phone but no answer came back; it is never repeated. Ask the signer to dismiss any prompt and retry after two minutes. None of these is billed.

sandboxboolean
completionMode'signed' | 'sandbox_simulation'
createdAtstring date-time required
completedAtstring date-time nullable

Changes

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