Skip to content

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
tenant
required
string

Tenant slug

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
defaultSenderName
required
string
costsWaived
required
boolean
Example
{
"plan": "Starter",
"addOnPlans": [
"Starter"
],
"ses": {
"seal": {
"state": "NotConfigured"
}
},
"connection": {
"defaultLevel": "Ses"
}
}

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

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
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}