Add a party to document
Add a party (signer/participant) to a document. The party must reference an existing contact.
Party Roles:
SIGNER- Must sign the documentORGANIZER- Document organizer (no signature required)REVIEWER- Reviews document (no signature required)
Per-Party Settings:
deliveryMethod- How to notify:EMAIL(default),SMS, orNONE(use signing URL directly)requiredSignature- Signature type:DRAWING,SE_BANKID(Swedish BankID),CLICK_TO_SIGN,MANUAL, or a national eID scheme. eID schemes are switched on market by market — callGET /api/v1/helpers/signature-methodsfor the set your account can actually use rather than hard-coding a listtwoStepVerification- identity gate passed BEFORE the document opens:NONE(default),PIN_BEFORE_SIGNING,SMS_BEFORE_SIGNING,EMAIL_BEFORE_SIGNING, or an eID gate such asSE_BANKID_BEFORE_SIGNING— callGET /api/v1/helpers/two-step-verificationsfor the live list
Signing Order: For SEQUENTIAL signing, specify the order (1, 2, 3…). For PARALLEL signing, order is ignored.
Response: Returns the created party, with its signingUrl, in the shape of GET /api/v1/documents/:id/parties/:partyId. sajn logs that you read the signing URL in the document’s audit trail.
Authorizations
Personal API key, e.g. Authorization: Bearer sajn_sk_.... Not scope-limited — acts as the issuing user.
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 Makes retries safe. A retry with the same key and the same request replays the stored response for 24 hours (header Idempotent-Replayed: true); the same key with a different request returns 400.
255Path Parameters
The document ID.
Body
Body
Create signer request
ID of the contact to add as a signer
1Party role: SIGNER, ORGANIZER, or REVIEWER.
SIGNER, ORGANIZER, REVIEWER Signing order for sequential signing (ignored for parallel)
How to send to this signer: EMAIL (default), SMS, or NONE
EMAIL, SMS, NONE, IN_APP Signature type required: DRAWING (default), SE_BANKID, or CLICK_TO_SIGN
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 Two-step verification: NONE (default), SMS_BEFORE_SIGNING, EMAIL_BEFORE_SIGNING, or SE_BANKID_BEFORE_SIGNING
NONE, SMS_BEFORE_SIGNING, EMAIL_BEFORE_SIGNING, PIN_BEFORE_SIGNING, SE_BANKID_BEFORE_SIGNING, NO_BANKID_BIOMETRIC_BEFORE_SIGNING, NO_BANKID_HIGH_BEFORE_SIGNING, DK_MITID_BEFORE_SIGNING, DK_MITID_ERHVERV_BEFORE_SIGNING, FI_FTN_BEFORE_SIGNING, NL_IDIN_BEFORE_SIGNING 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-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 documents are sent to this signer: EMAIL, SMS, or NONE
EMAIL, SMS, NONE, IN_APP, null Signature type required: DRAWING, SE_BANKID, CLICK_TO_SIGN, etc.
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, null Two-step verification: NONE, SMS_BEFORE_SIGNING, EMAIL_BEFORE_SIGNING, or SE_BANKID_BEFORE_SIGNING
NONE, SMS_BEFORE_SIGNING, EMAIL_BEFORE_SIGNING, PIN_BEFORE_SIGNING, SE_BANKID_BEFORE_SIGNING, NO_BANKID_BIOMETRIC_BEFORE_SIGNING, NO_BANKID_HIGH_BEFORE_SIGNING, DK_MITID_BEFORE_SIGNING, DK_MITID_ERHVERV_BEFORE_SIGNING, FI_FTN_BEFORE_SIGNING, NL_IDIN_BEFORE_SIGNING, 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

