Skip to Content
Document parties

Update a party

PATCH
/api/v1/documents/{id}/parties/{partyId}

Update party information. Most fields can only be updated before the document is sent.

After the document is sent, you can change only name, email, and phone, and only for a party that hasn't signed. Other parties' signatures stay valid. Replacing an email address or phone number issues a new signing link, so the old link stops working, and a party who already got the invitation through that channel gets it again. Any other property returns 409 INVALID_STATE.

A field you leave out keeps its value. To clear phone, externalId, nationalId, or a key of company, pass null.

Updatable Fields:

  • name - Party's full name
  • email - Party's email address
  • phone - Party's phone number
  • company - The company the party signs for: id links a company in your workspace, and name, orgNumber, and role describe it. Pass company: null to make the party a private individual.
  • externalId - Your external reference ID for the party
  • nationalId - National identity number, such as a Swedish personnummer, matched against the eID at signing
  • role - Party role (SIGNER, ORGANIZER, REVIEWER)
  • signingOrder - Order for sequential signing
  • delivery - How the party gets the invitation: ["EMAIL"], ["SMS"], ["IN_APP"] to sign in person on your device, or [] to send nothing and share the signing URL yourself
  • signatureMethod - 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 call GET /api/v1/helpers/signature-methods for the set your account can use
  • 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 live list

Restrictions: Cannot update after party has signed the document.

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

id*string

The document ID.

partyId*string

The party ID.

Header Parameters

Sajn-Version?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.

Value in"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.

Idempotency-Key?string

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.

Lengthlength <= 255

Request Body

Body

application/json
  1. body
name?string
email?string
Match^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Formatemail
phone?|

Phone number. Pass null to clear it.

company?|

The company the party signs for. A key you leave out keeps its value. Pass null to clear every company field.

externalId?|

Your external reference ID for the party. Pass null to clear it.

nationalId?|

National identity number, such as a Swedish personnummer, matched against the eID at signing. Pass null to clear it.

country?string

ISO 3166-1 alpha-2 country code of the party, such as SE or DE

role?string

Party role: SIGNER, ORGANIZER, or REVIEWER.

Value in"SIGNER""ORGANIZER""REVIEWER"
signingOrder?number|null
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?string

How 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.

Value in"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.

Value in"PIN""SMS""EMAIL""SE_BANKID""NO_BANKID_BIOMETRIC""NO_BANKID_HIGH""DK_MITID""DK_MITID_ERHVERV""FI_FTN""NL_IDIN"null
openVerification?|

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.

Value in"PIN""SMS""EMAIL""SE_BANKID""NO_BANKID_BIOMETRIC""NO_BANKID_HIGH""DK_MITID""DK_MITID_ERHVERV""FI_FTN""NL_IDIN"null

Response Body

200

application/json
  1. response
id*string

The party ID

documentId*string

The ID of the document the party belongs to

email*|

Signer email address

Match^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Formatemail
name*string

Signer full name

phone*|

Signer phone number (for SMS notifications)

type*string

Party type: INDIVIDUAL or COMPANY

Value in"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*string

Signer role: SIGNER, ORGANIZER, or REVIEWER

Value in"SIGNER""ORGANIZER""REVIEWER"
signingOrder*|

Order for sequential signing (null for parallel)

signedAt*|

Date and time when the signer signed (null if not signed)

Formatdate-time
readStatus*string

Read status: NOT_OPENED, OPENED, or READ

Value in"NOT_OPENED""OPENED""READ"
signingStatus*string

Signing status: NOT_SIGNED, SIGNED, or REJECTED

Value in"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.

Value in"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*|

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.

Value in"PIN""SMS""EMAIL""SE_BANKID""NO_BANKID_BIOMETRIC""NO_BANKID_HIGH""DK_MITID""DK_MITID_ERHVERV""FI_FTN""NL_IDIN"null
openVerification*|

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.

Value in"PIN""SMS""EMAIL""SE_BANKID""NO_BANKID_BIOMETRIC""NO_BANKID_HIGH""DK_MITID""DK_MITID_ERHVERV""FI_FTN""NL_IDIN"null
sendStatus*|

Send status: NOT_SENT, SENT, DELIVERED, BOUNCED, or FAILED

Value in"NOT_SENT""SENT""DELIVERED""BOUNCED""FAILED"null
signingUrl*string

Complete signing URL for this signer

identityVerified*boolean

True when an eID verified this signer — either by signing with one or by passing an eID verification gate.

identityMismatch*boolean

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.

createdAt*string

When the party was added to the document

Formatdate-time
Example Request
curl -X PATCH 'https://app.sajn.se/api/v1/documents/cm4k2x9p10003abcd1234efgh/parties/cm4k2x9p10004abcd1234efgh' \  -H 'Content-Type: application/json' \  -d '{  "phone": "+46701740605",  "delivery": [    "SMS"  ]}'
Example Response
{  "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": [    "SMS"  ],  "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?