Update a party
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 nameemail- Party’s email addressphone- Party’s phone numbercompany- The company the party signs for:idlinks a company in your workspace, andname,orgNumber, androledescribe it. Passcompany: nullto make the party a private individual.externalId- Your external reference ID for the partynationalId- National identity number, such as a Swedish personnummer, matched against the eID at signingrole- Party role (SIGNER, ORGANIZER, REVIEWER)signingOrder- Order for sequential signingdeliveryMethod- How to notify:EMAIL,SMS, orNONErequiredSignature- 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,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
Restrictions: Cannot update after party has signed the document.
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.
255Body
Body
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$Phone number. Pass null to clear it.
The company the party signs for. A key you leave out keeps its value. Pass null to clear every company field.
Your external reference ID for the party. Pass null to clear it.
National identity number, such as a Swedish personnummer, matched against the eID at signing. Pass null to clear it.
ISO 3166-1 alpha-2 country code of the party, such as SE or DE
Party role: SIGNER, ORGANIZER, or REVIEWER.
SIGNER, ORGANIZER, REVIEWER How to send to this signer: EMAIL, SMS, or NONE
EMAIL, SMS, NONE, IN_APP Signature type required: DRAWING, 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, 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

