Skip to main content
GET
/
signing
/
{signingSessionId}
{
  "signingSessionId": "f7d2295f-0dd4-4ebe-8ec5-de2d0f41be7e",
  "orderId": "44567801-a504-4f09-8089-31ea78bc239b",
  "status": "PENDING",
  "signerDetails": {
    "name": "John Doe",
    "email": "john.doe@example.com",
    "identity": "199001011234"
  },
  "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",
  "createdAt": "2024-01-15T10:00:00Z",
  "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.

Path Parameters

​
signingSessionId
string
required

The unique identifier for the signing session.

Response

Signing session details.

A contract signing session for an order requiring legal signature.

​
signingSessionId
string
required

The unique identifier for this signing session.

Example:

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

​
orderId
string
required

The order that requires signing.

Example:

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

​
status
enum<string>
required

The current status of a signing session.

Available options:
PENDING,
IN_PROGRESS,
COMPLETED,
FAILED,
EXPIRED,
CANCELLED
​
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.

Example:
{
  "name": "John Doe",
  "email": "john.doe@example.com",
  "identity": "199001011234"
}
​
createdAt
string<date-time>
required

When the signing session was created.

Example:

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

​
provider
string

The signing provider used for this session.

Example:

"bankid"

​
language
string
default:en

The language used for the signing interface.

Example:

"en"

​
redirectUrl
string<uri>

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

Example:

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

​
returnUrl
string<uri>

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

Example:

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

​
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"

​
completedAt
string<date-time>

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

Example:

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

​
expiresAt
string<date-time>

When this signing session expires.

Example:

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

​
failureReason
string

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

Example:

"User cancelled signing process"

​
metadata
object

Additional metadata for the signing session.

Example:
{
  "contract_type": "postpaid_subscription",
  "customer_segment": "b2b"
}
⌘I