List signing sessions

Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "signingSessionId": "f7d2295f-0dd4-4ebe-8ec5-de2d0f41be7e",
      "orderId": "44567801-a504-4f09-8089-31ea78bc239b",
      "status": "PENDING",
      "signerDetails": {
        "name": "John Doe",
        "email": "[email protected]",
        "identity": "199001011234"
      },
      "createdAt": "2024-01-15T10:00:00Z",
      "provider": "bankid",
      "language": "en",
      "redirectUrl": "https://sign.provider.com/session/abc123",
      "returnUrl": "https://yourapp.com/orders/123/complete",
      "documentUrl": "https://api.yourapp.com/documents/signed-contract-123.pdf",
      "completedAt": "2024-01-15T14:30:00Z",
      "expiresAt": "2024-01-15T23:59:59Z",
      "failureReason": "User cancelled signing process",
      "metadata": {
        "contract_type": "postpaid_subscription",
        "customer_segment": "b2b"
      }
    }
  ]
}

GET

signing

Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "signingSessionId": "f7d2295f-0dd4-4ebe-8ec5-de2d0f41be7e",
      "orderId": "44567801-a504-4f09-8089-31ea78bc239b",
      "status": "PENDING",
      "signerDetails": {
        "name": "John Doe",
        "email": "[email protected]",
        "identity": "199001011234"
      },
      "createdAt": "2024-01-15T10:00:00Z",
      "provider": "bankid",
      "language": "en",
      "redirectUrl": "https://sign.provider.com/session/abc123",
      "returnUrl": "https://yourapp.com/orders/123/complete",
      "documentUrl": "https://api.yourapp.com/documents/signed-contract-123.pdf",
      "completedAt": "2024-01-15T14:30:00Z",
      "expiresAt": "2024-01-15T23:59:59Z",
      "failureReason": "User cancelled signing process",
      "metadata": {
        "contract_type": "postpaid_subscription",
        "customer_segment": "b2b"
      }
    }
  ]
}

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

orderId

string

Filter by order ID.

status

enum<string>[]

Filter by signing status.

The current status of a signing session.

Available options:

PENDING,

IN_PROGRESS,

COMPLETED,

FAILED,

EXPIRED,

CANCELLED

limit

integer

default:100

The maximum number of items to return.

Required range: 1 <= x <= 1000

offset

integer

default:0

The number of items to skip before starting to collect the result set.

Required range: x >= 0

Response

List of signing sessions.

items

object[]

required

Show child attributes

items.signingSessionId

string

required

The unique identifier for this signing session.

Example:

"f7d2295f-0dd4-4ebe-8ec5-de2d0f41be7e"

items.orderId

string

required

The order that requires signing.

Example:

"44567801-a504-4f09-8089-31ea78bc239b"

items.status

enum<string>

required

The current status of a signing session.

Available options:

PENDING,

IN_PROGRESS,

COMPLETED,

FAILED,

EXPIRED,

CANCELLED

items.signerDetails

object

required

Information about the person signing the contract.

The specific fields required depend on the signing provider. Use GET /signing/providers to discover which fields are required for each provider.

Show child attributes

items.signerDetails.{key}

string

Example:

{
  "name": "John Doe",
  "email": "[email protected]",
  "identity": "199001011234"
}

items.createdAt

string<date-time>

required

When the signing session was created.

Example:

"2024-01-15T10:00:00Z"

items.provider

string

The signing provider used for this session.

Example:

"bankid"

items.language

string

default:en

The language used for the signing interface.

Example:

"en"

items.redirectUrl

string<uri>

The URL where the user should be redirected to complete signing.

Example:

"https://sign.provider.com/session/abc123"

items.returnUrl

string<uri>

The URL where the user will be redirected after signing completion.

Example:

"https://yourapp.com/orders/123/complete"

items.documentUrl

string<uri>

Download URL for the signed contract. Only available when status is COMPLETED.

Example:

"https://api.yourapp.com/documents/signed-contract-123.pdf"

items.completedAt

string<date-time>

When the signing was completed. Only present when status is COMPLETED.

Example:

"2024-01-15T14:30:00Z"

items.expiresAt

string<date-time>

When this signing session expires.

Example:

"2024-01-15T23:59:59Z"

items.failureReason

string

The reason for signing failure. Only present when status is FAILED.

Example:

"User cancelled signing process"

items.metadata

object

Additional metadata for the signing session.

Show child attributes

items.metadata.{key}

string

Example:

{
  "contract_type": "postpaid_subscription",
  "customer_segment": "b2b"
}

Get product offering Create signing session

⌘I

Getting started

Overview

API reference

Authorizations

Query Parameters

Response