Get a party with signing URL
Retrieve a specific party including their signing URL.
Security Note: This endpoint creates an audit log entry each time a signing URL is accessed. Use this endpoint when you need the signing URL to share with the party.
Response includes:
- Party details (name, email, phone, company info)
- Signing status (NOT_SIGNED, SIGNED, REJECTED)
- Read status (NOT_OPENED, OPENED, READ)
- Complete signing URL with token
Authorizations
API key, e.g. Authorization: Bearer sajn_svc_.... Not scope-limited: acts with its owner's workspace role.
Headers
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.
2026-09, 2026-10 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.
Response
200
The party ID
The ID of the document the party belongs to
Signer email address
^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$Signer full name
Signer phone number (for SMS notifications)
Party type: INDIVIDUAL or COMPANY
INDIVIDUAL, COMPANY The company the party signs for, or null for a private individual
Your external reference ID for this signer
ID of the contact this party was created from, if any
National identity number supplied by the sender when creating the document. Optional — BankID works without it, falling back to a name check. This is input and is never overwritten with what the eID verified: read the verified identity from GET /api/v1/documents/{id}/signatures.
ISO 3166-1 alpha-2 country code of the party, such as SE
Signer role: SIGNER, ORGANIZER, or REVIEWER
SIGNER, ORGANIZER, REVIEWER Order for sequential signing (null for parallel)
Date and time when the signer signed (null if not signed)
Read status: NOT_OPENED, OPENED, or READ
NOT_OPENED, OPENED, READ Signing status: NOT_SIGNED, SIGNED, or REJECTED
NOT_SIGNED, SIGNED, REJECTED 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.
EMAIL, SMS, IN_APP How the party signs: DRAWING, SE_BANKID, CLICK_TO_SIGN, or another eID.
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 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.
PIN, SMS, EMAIL, SE_BANKID, NO_BANKID_BIOMETRIC, NO_BANKID_HIGH, DK_MITID, DK_MITID_ERHVERV, FI_FTN, NL_IDIN, null Verification this party passes before the document opens, in place of the document's openVerification: SMS, EMAIL, or an eID such as SE_BANKID. null uses the document's. PIN only gates signing, so it isn't accepted here.
PIN, SMS, EMAIL, SE_BANKID, NO_BANKID_BIOMETRIC, NO_BANKID_HIGH, DK_MITID, DK_MITID_ERHVERV, FI_FTN, NL_IDIN, null Send status: NOT_SENT, SENT, DELIVERED, BOUNCED, or FAILED
NOT_SENT, SENT, DELIVERED, BOUNCED, FAILED, null Complete signing URL for this signer
True when an eID verified this signer — either by signing with one or by passing an eID verification gate.
True when an eID completed, the identity did not match the intended signer, and the signature was still recorded — read GET /api/v1/documents/{id}/signatures to see what differed. Stays false when the workspace requires a national ID match to sign and the attempt was refused, because no signature exists; those attempts appear only in the document audit trail.
When the party was added to the document

