List signing providers

Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "provider": "bankid",
      "name": "BankID",
      "requirements": {
        "name": "REQUIRED",
        "email": "REQUIRED",
        "identity": "REQUIRED"
      },
      "description": "Swedish digital identity verification and signing service",
      "supportedCountries": [
        "SE"
      ],
      "supportedLanguages": [
        "sv",
        "en"
      ],
      "capabilities": {
        "multipleSigners": false,
        "documentTemplates": true,
        "biometricSigning": true
      }
    }
  ]
}

GET

signing

providers

Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "provider": "bankid",
      "name": "BankID",
      "requirements": {
        "name": "REQUIRED",
        "email": "REQUIRED",
        "identity": "REQUIRED"
      },
      "description": "Swedish digital identity verification and signing service",
      "supportedCountries": [
        "SE"
      ],
      "supportedLanguages": [
        "sv",
        "en"
      ],
      "capabilities": {
        "multipleSigners": false,
        "documentTemplates": true,
        "biometricSigning": true
      }
    }
  ]
}

Authorizations

X-Api-Key

string

header

required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Query Parameters

country

string

Filter providers by supported country code.

Example:

"SE"

language

string

Filter providers by supported language code.

Example:

"sv"

Response

List of available signing providers.

items

object[]

required

Available signing providers and their requirements.

Show child attributes

items.provider

string

required

The unique identifier for the signing provider.

Example:

"bankid"

items.name

string

required

The display name of the signing provider.

Example:

"BankID"

items.requirements

object

required

Information that may or must be collected from the signer before initiating the signing process.

Each key represents a field name in the signerDetails object, and the value indicates whether it's optional or required.

Show child attributes

items.requirements.{key}

enum<string>

Whether a signer detail field is optional or required for a signing provider.

'OPTIONAL': The field is optional and may be omitted.
'REQUIRED': The field is required and must be provided.

Available options:

OPTIONAL,

REQUIRED

Example:

{
  "name": "REQUIRED",
  "email": "REQUIRED",
  "identity": "REQUIRED"
}

items.description

string

A brief description of the signing provider and its use cases.

Example:

"Swedish digital identity verification and signing service"

items.supportedCountries

string[]

List of country codes where this provider is available.

Example:

["SE"]

items.supportedLanguages

string[]

List of language codes supported by this provider.

Example:

["sv", "en"]

items.capabilities

object

Additional capabilities and features supported by this provider.

Show child attributes

items.capabilities.multipleSigners

boolean

Whether the provider supports multiple signers on the same document.

Example:

false

items.capabilities.documentTemplates

boolean

Whether the provider supports custom document templates.

Example:

true

items.capabilities.biometricSigning

boolean

Whether the provider supports biometric signing methods.

Example:

true

Create signing session Get signing session

⌘I

Getting started

Overview

API reference

Authorizations

Query Parameters

Response