Skip to main content
GET
/
signing
List signing sessions
curl --request GET \
  --url https://apiv2.example.com/signing \
  --header 'X-Api-Key: <api-key>'
{
  "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
​
cursor
string

Opaque pagination token from a previous response's nextCursor.

Response

List of signing sessions.

​
items
object[]
required