Skip to main content
POST
/
signing
Error
A valid request URL is required to generate request examples
{
  "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.

Headers

​
X-Idempotency-Key
string

A unique key to ensure idempotency of requests. If a request with the same key has already been processed, the same result will be returned. The key must be unique for each distinct operation. Keys are expired after 24 hours, but we recommend using a new key for each request.

Modified requests with the same idempotency keys are rejected with a 409 Conflict status code.

Maximum string length: 256

Body

application/json

Request to create a contract signing session for an order.

​
orderId
string
required

The order that requires contract signing.

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
signerDetails
object
required

Information about the person who will sign 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": "[email protected]",
  "identity": "199001011234"
}
​
returnUrl
string<uri>
required

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

Example:

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

​
provider
string

The preferred signing provider. If not specified, the default provider will be used.

Example:

"bankid"

​
language
string
default:en

The language for the signing interface.

Example:

"sv"

​
metadata
object

Additional metadata for the signing session.

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

Response

Signing session created successfully.

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": "[email protected]",
  "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"
}