Skip to main content
GET
Get a bundle party with signing URL

Authorizations

Authorization
string
header
required

API key, e.g. Authorization: Bearer sajn_svc_.... Not scope-limited: acts with its owner's workspace role.

Headers

Sajn-Version
enum<string>

API version for this request. Without it, the request uses the organization's default version; an organization without a default is pinned to the latest version by its first request.

Available options:
2026-09,
2026-10
Sajn-Workspace
string

ID of the workspace this request acts in, from GET /api/v1/workspaces. Without it, an API key acts in its default workspace. The token's user must be a member of the workspace; an OAuth token only accepts the workspace it was granted for. A workspace that doesn't exist or can't be reached returns 403 WORKSPACE_ACCESS_DENIED.

Path Parameters

id
string
required

The bundle ID.

partyId
string
required

The party ID.

Response

200

id
string
required

The party ID. To get the party's signing URL, pass it to GET /api/v1/bundles/{id}/parties/{partyId}.

name
string
required
email
string<email>
required

The email address the party gets the invitation at. A bundle has one party per email address.

Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
phone
string | null
required
role
enum<string>
required
Available options:
SIGNER,
ORGANIZER,
REVIEWER
signingOrder
integer | null
required

The party's step for SEQUENTIAL signing.

Required range: -9007199254740991 <= x <= 9007199254740991
delivery
enum<string>[]
required

How the party gets the invitation: ["EMAIL"], ["SMS"], ["EMAIL", "SMS"] for both, or ["IN_APP"] to sign in person on your device. [] sends nothing, so you share the signing URL yourself. Each channel needs the matching contact detail.

Available options:
EMAIL,
SMS,
IN_APP
signatureMethod
enum<string> | null
required

How the party signs: DRAWING, SE_BANKID, CLICK_TO_SIGN, or another eID.

Available options:
NONE,
DRAWING,
SE_BANKID,
MANUAL,
CLICK_TO_SIGN,
NO_BANKID_BIOMETRIC,
NO_BANKID_HIGH,
NO_QES,
DK_MITID,
DK_MITID_ERHVERV,
FI_FTN,
NL_IDIN,
ZEALID_QES,
null
signVerification
enum<string> | null
required

Verification the party passes before signing: PIN, SMS, EMAIL, or an eID such as SE_BANKID. null means none. Call GET /api/v1/helpers/two-step-verifications for the methods your account can use.

Available options:
PIN,
SMS,
EMAIL,
SE_BANKID,
NO_BANKID_BIOMETRIC,
NO_BANKID_HIGH,
DK_MITID,
DK_MITID_ERHVERV,
FI_FTN,
NL_IDIN,
null
openVerification
enum<string> | null
required

Verification this party passes before the documents open, in place of the bundle's openVerification. null uses the bundle's.

Available options:
PIN,
SMS,
EMAIL,
SE_BANKID,
NO_BANKID_BIOMETRIC,
NO_BANKID_HIGH,
DK_MITID,
DK_MITID_ERHVERV,
FI_FTN,
NL_IDIN,
null
status
enum<string> | null
required

SIGNED when the party has signed every one of their documents, REJECTED when they rejected any of them, otherwise PENDING. null for a party that doesn't sign, an ORGANIZER or REVIEWER.

Available options:
PENDING,
SIGNED,
REJECTED,
null
documentIds
string[]
required

The documents in the bundle the party is on.

bundleId
string
required

The bundle ID.

signingUrl
string
required

The bundle page for this party. It opens every document they sign in the bundle.