account

Get account capabilities

Returns which features and add-ons are enabled for the account.

Use this endpoint to check what is available before calling endpoints that require specific capabilities. Attempting to use a capability that is not enabled returns 403 Forbidden.

Capabilities

Capability	Description
deliverySms	phoneNumberDeliveryMethod: sms on signee
deliveryWhatsapp	phoneNumberDeliveryMethod: whatsapp on signee
templates	GET /templates, using templateId on document
templatesCreate	POST /templates
signingOrder	enableSigningOrder: true on document
signAndPay	Sign & Pay feature
signAndPayCreate	Create Sign & Pay links
signatureBankId	bankid_identification signature type
signatureIdScan	digital_ink_id_scan signature type
signatureFaceLiveness	face_liveness signature type
verificationToOpen	Verification-to-open setting on documents
disableSubmit	Disable submit/sign setting on documents
searchableFormFields	Searchable form fields
apiAccess	API integration settings
companyLogo	Custom company logo
sharedDocuments	Shared document settings within account
verificationEmail	Email address verification add-on
verificationPhone	Mobile number verification add-on
initials	Initials add-on
aiAssistant	aiAssistant.enabled: true on document
aiAssistantCustomProfile	Custom AI assistant profile

get/account/capabilities

Request

Base URL: https://docs-api.formify.eu/v1
URL: https://docs-api.formify.eu/v1/account/capabilities
Auth: OAuth 2 (authorization code, authorization URL https://docs-api.formify.eu/v1/oauth/authorize, token URL https://docs-api.formify.eu/v1/oauth/token)

Query parameters

errorLanguage'en' | 'sv' | 'es'

Language for the error message

Response

Account capabilities retrieved successfully.

deliverySmsboolean

Whether SMS delivery is enabled for signee invitations and reminders.

deliveryWhatsappboolean

Whether WhatsApp delivery is enabled for signee invitations and reminders.

templatesboolean

Whether templates can be used (e.g. listed and applied to documents).

templatesCreateboolean

Whether new templates can be created.

signingOrderboolean

Whether sequential signing order is enabled for multi-party documents.

signAndPayboolean

Whether the Sign & Pay feature is enabled.

signAndPayCreateboolean

Whether Sign & Pay links can be created.

signatureBankIdboolean

Whether the bankid_identification signature type is enabled.

signatureIdScanboolean

Whether the digital_ink_id_scan signature type is enabled.

signatureFaceLivenessboolean

Whether the face_liveness signature type is enabled.

verificationToOpenboolean

Whether the verification-to-open setting can be enabled on documents.

disableSubmitboolean

Whether the disable submit/sign setting can be enabled on documents.

searchableFormFieldsboolean

Whether searchable form fields are enabled.

apiAccessboolean

Whether API integration settings are accessible.

companyLogoboolean

Whether a custom company logo can be configured.

sharedDocumentsboolean

Whether shared document settings within the account are enabled.

verificationEmailboolean

Whether the Email Address Verification add-on is enabled.

verificationPhoneboolean

Whether the Mobile Number Verification add-on is enabled.

initialsboolean

Whether the Initials add-on is enabled.

aiAssistantboolean

Whether the AI Assistant feature is enabled for the account.

aiAssistantCustomProfileboolean

Whether a custom AI assistant profile can be configured.

Example response

{
  "deliverySms": true,
  "deliveryWhatsapp": false,
  "templates": true,
  "templatesCreate": true,
  "signingOrder": true,
  "signAndPay": false,
  "signAndPayCreate": false,
  "signatureBankId": false,
  "signatureIdScan": true,
  "signatureFaceLiveness": false,
  "verificationToOpen": false,
  "disableSubmit": false,
  "searchableFormFields": false,
  "apiAccess": true,
  "companyLogo": true,
  "sharedDocuments": false,
  "verificationEmail": false,
  "verificationPhone": false,
  "initials": false,
  "aiAssistant": false,
  "aiAssistantCustomProfile": false
}

Changes

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