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:
delivery- How the party gets the invitation:["EMAIL"](default),["SMS"],["IN_APP"]to sign in person on your device, or[]to send nothing and share the signing URL yourselfsignatureMethod- How the party signs:DRAWING,SE_BANKID(Swedish BankID),CLICK_TO_SIGN,MANUAL, or a national eID scheme. eID schemes are switched on market by market, so callGET /api/v1/helpers/signature-methodsfor the set your account can usesignVerification- Verification the party passes before signing:PIN,SMS,EMAIL, or an eID such asSE_BANKID. null (default) means none. 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.
AuthorizationBearer <token>API key, e.g. Authorization: Bearer sajn_svc_.... Not scope-limited: acts with its owner's workspace role.
id*stringThe document ID.
Sajn-Version?stringAPI 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"Sajn-Workspace?stringID 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.
Idempotency-Key?stringMakes 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.
length <= 255Body
application/json- body
Create signer request
contactId*stringID of the contact to add as a signer
1 <= lengthrole?stringParty role: SIGNER, ORGANIZER, or REVIEWER.
"SIGNER""SIGNER""ORGANIZER""REVIEWER"signingOrder?|Signing order for sequential signing (ignored for parallel)
delivery?array<>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.
signatureMethod?stringHow the party signs: DRAWING, SE_BANKID, CLICK_TO_SIGN, or another eID. Call GET /api/v1/helpers/signature-methods for the methods your account can use. Defaults to the workspace setting.
"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"signVerification?|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"nullopenVerification?|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"null200
application/json- response
id*stringThe party ID
documentId*stringThe ID of the document the party belongs to
email*|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,}$emailname*stringSigner full name
phone*|Signer phone number (for SMS notifications)
type*stringParty type: INDIVIDUAL or COMPANY
"INDIVIDUAL""COMPANY"company*|The company the party signs for, or null for a private individual
externalId*|Your external reference ID for this signer
contactId*|ID of the contact this party was created from, if any
nationalId*|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.
country*|ISO 3166-1 alpha-2 country code of the party, such as SE
role*stringSigner role: SIGNER, ORGANIZER, or REVIEWER
"SIGNER""ORGANIZER""REVIEWER"signingOrder*|Order for sequential signing (null for parallel)
signedAt*|Date and time when the signer signed (null if not signed)
date-timereadStatus*stringRead status: NOT_OPENED, OPENED, or READ
"NOT_OPENED""OPENED""READ"signingStatus*stringSigning status: NOT_SIGNED, SIGNED, or REJECTED
"NOT_SIGNED""SIGNED""REJECTED"delivery*array<>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.
signatureMethod*|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"nullsignVerification*|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"nullopenVerification*|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"nullsendStatus*|Send status: NOT_SENT, SENT, DELIVERED, BOUNCED, or FAILED
"NOT_SENT""SENT""DELIVERED""BOUNCED""FAILED"nullsigningUrl*stringComplete signing URL for this signer
identityVerified*booleanTrue when an eID verified this signer — either by signing with one or by passing an eID verification gate.
identityMismatch*booleanTrue 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.
createdAt*stringWhen the party was added to the document
date-timecurl -X POST 'https://app.sajn.se/api/v1/documents/cm4k2x9p10003abcd1234efgh/parties' \ -H 'Content-Type: application/json' \ -d '{ "contactId": "cm4k2x9p10006abcd1234efgh", "role": "SIGNER", "signatureMethod": "SE_BANKID"}'{ "id": "cm4k2x9p10004abcd1234efgh", "documentId": "cm4k2x9p10003abcd1234efgh", "email": "kai@example.com", "name": "Kai Lindqvist", "phone": "+46701740605", "type": "INDIVIDUAL", "company": null, "externalId": "HR-2026-0142", "contactId": "cm4k2x9p10006abcd1234efgh", "nationalId": "191212121212", "country": "SE", "role": "SIGNER", "signingOrder": 1, "signedAt": null, "readStatus": "NOT_OPENED", "signingStatus": "NOT_SIGNED", "delivery": [ "EMAIL" ], "signatureMethod": "SE_BANKID", "signVerification": "PIN", "openVerification": "PIN", "sendStatus": "NOT_SENT", "signingUrl": "https://app.sajn.se/sign/cm4k2x9p10003abcd1234efgh?token=Xk9mQ2vR7tLp4wZs8nYb3", "identityVerified": false, "identityMismatch": false, "createdAt": "2026-09-28T09:12:00.000Z"}Was this page helpful?