Skip to content
AveraAveraAvera Documentation

Revoke an e-signature

POST
/api/v1/signatures/{id}/revoke
curl --request POST \
  --url https://app.avera.io/api/v1/signatures/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/revoke \
  --header 'Content-Type: application/json' \
  --data '{ "reason": "example" }'

Revocation requires a reason and is itself a regulated action: only the original signer may revoke their own signature, anyone else must be a tenant administrator. The record is kept with its revocation reason, never deleted.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
reason
required
string
0 <= 512 characters

Example generated

{
  "reason": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
object
id
required
string format: uuid
tenantId
required
string format: uuid
signatureNumber
required
string
targetType
required
string
Allowed values: ITEM ATTACHMENT RECORD CONFIGURATION_VERSION
targetId
required
string format: uuid
targetVersion
required
integer format: int64
documentHash
required
string
documentHashAlgorithm
required
string
signaturePurpose
required
string
Allowed values: AUTHOR REVIEWER APPROVER WITNESS ACKNOWLEDGEMENT QUALITY_RELEASE REGULATORY_SUBMISSION
signatureLevel
required
string
Allowed values: SIMPLE ADVANCED ADVANCED_STRONG QUALIFIED QUALIFIED_TIMESTAMPED
signatureMeaning
required
string
signerUserId
required
string format: uuid
signerHomeTenantId
string | null format: uuid
participationId
required
string format: uuid
participationScope
required
string
Allowed values: INTERNAL EXTERNAL SUPPORT
signerName
required
string
signerEmail
required
string
signerOrganization
string | null
identityAssertedVia
required
string
Allowed values: LOCAL SSO DIRECTORY_SYNC STAFF_SSO
vendorUserId
string | null
identityAssertedAt
required
string format: date-time
signingFactorType
string | null
Allowed values: PIN WEBAUTHN TOTP QES_QTSP
signingFactorVerifiedAt
string | null format: date-time
signedAt
required
string format: date-time
status
required
string
Allowed values: VALID REVOKED EXPIRED SUPERSEDED
revokedAt
string | null format: date-time
revokedBy
string | null format: uuid
revocationReason
string | null
signaturePolicyId
string | null format: uuid