The e-signature settings: the add-on, the simple signature with its seal, and the provider connection

GET

/api/v1/t/{tenant}/signatures/connection

curl --request GET \
  --url https://example.com/api/v1/t/example/signatures/connection

Parameters

Path Parameters

tenant

required

string

Tenant slug

Responses

200

OK

Media typeapplication/json

object

addOnBooked

required

boolean

plan

required

Allowed values: Starter Business Enterprise Trial

planName

required

string

addOnPlans

required

Array

Allowed values: Starter Business Enterprise Trial

ses

required

object

requestsPerMonth

required

integer format: int32

reminderIntervalDays

required

integer format: int32

maxReminders

required

integer format: int32

seal

required

object

state

required

Allowed values: NotConfigured Unavailable Valid ExpiresSoon ExpiresVerySoon Expired NotYetValid

subject

required

null | string

issuer

required

null | string

selfIssued

required

null | boolean

notAfter

required

null | string format: date-time

connection

required

One of:

null

null

object

object

provider

required

string

kind

required

string

active

required

boolean

workspaceId

required

null | string

aesActivated

required

boolean

qesActivated

required

boolean

checkedAt

required

null | string format: date-time

defaultLevel

required

One of:

null

null

unknown

Allowed values: Ses Aes Qes

reminderIntervalDays

required

null | integer format: int32

senderName

required

null | string

version

required

integer format: uint32

defaultSenderName

required

string

costsWaived

required

boolean

Example

{
  "plan": "Starter",
  "addOnPlans": [
    "Starter"
  ],
  "ses": {
    "seal": {
      "state": "NotConfigured"
    }
  },
  "connection": {
    "defaultLevel": "Ses"
  }
}

403

Forbidden

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Too Many Requests

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}