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 signingdelivery- 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 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 means none. CallGET /api/v1/helpers/two-step-verificationsfor the live list
Restrictions: Cannot update after party has signed the document.
Authorizations
Headers
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.
Body
Body
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.
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 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 Response
200
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.
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 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 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.

