Skip to Content

Update a party

You're viewing API version 2026-09, which is deprecated and stops working on October 1, 2027. To move your integration, see Upgrading to 2026-10.
PATCH
/api/v1/documents/{id}/parties/{partyId}

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

Updatable Fields:

  • name - Party's full name
  • email - Party's email address
  • phone - Party's phone number
  • companyName - Company name
  • companyRole - Role within company
  • companyOrgNumber - Company organization number
  • companyId - Link to existing company
  • ssn - Swedish personal number (for BankID)
  • role - Party role (SIGNER, ORGANIZER, REVIEWER)
  • signingOrder - Order for sequential signing
  • deliveryMethod - How to notify: EMAIL, SMS, or NONE
  • requiredSignature - Signature type: DRAWING, BANKID (Swedish BankID), CLICK_TO_SIGN, MANUAL, or a national eID scheme. eID schemes are switched on market by market — call GET /api/v1/helpers/signature-methods for the set your account can actually use rather than hard-coding a list
  • twoStepVerification - identity gate passed BEFORE the document opens: NONE, PIN_BEFORE_SIGNING, SMS_BEFORE_SIGNING, EMAIL_BEFORE_SIGNING, or an eID gate such as BANKID_BEFORE_SIGNING — call GET /api/v1/helpers/two-step-verifications for the live list

Restrictions: Cannot update after party has signed the document.

Authorization

headerAuthorizationBearer <token>

Personal API key, e.g. Authorization: Bearer sajn_sk_.... Not scope-limited — acts as the issuing user.

Path Parameters

id*string
partyId*string

Header Parameters

authorization*string

Bearer token for API authentication

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-z]{2,}$
Formatemail
phone?string
companyName?string
companyRole?string
companyOrgNumber?string
externalId?string
companyId?string
ssn?string
country?string

ISO 3166-1 alpha-3 country code for the signer (e.g. SWE, USA, DEU)

role*unknown

Party role: SIGNER, ORGANIZER, or REVIEWER. (ACCEPTOR is deprecated and treated as SIGNER.)

Default"SIGNER"
signingOrder?number|null
deliveryMethod?string

How to send to this signer: EMAIL, SMS, or NONE

Value in"EMAIL""SMS""NONE""IN_APP"
requiredSignature?string

Signature type required: DRAWING, BANKID, or CLICK_TO_SIGN

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"
twoStepVerification?string

Two-step verification: NONE, SMS_BEFORE_SIGNING, EMAIL_BEFORE_SIGNING, or BANKID_BEFORE_SIGNING

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

200

application/json
  1. response
id*string

Unique signer identifier

documentId*string

Document ID this signer 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-z]{2,}$
Formatemail
name*string

Signer full name

phone?|

Signer phone number (for SMS notifications)

companyName?|

Company name

companyRole?|

Role/title within the company

companyOrgNumber?|

Company organization number

externalId?|

Your external reference ID for this signer

companyId?|

Linked company ID

ssn?|

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-3 country code for the signer (e.g. SWE)

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"
deliveryMethod*|

How documents are sent to this signer: EMAIL, SMS, or NONE

Value in"EMAIL""SMS""NONE""IN_APP"
requiredSignature*|

Signature type required: DRAWING, BANKID, CLICK_TO_SIGN, etc.

Value in"NONE""DRAWING""BANKID""MANUAL""CLICK_TO_SIGN""NO_BANKID_BIOMETRIC""NO_BANKID_HIGH""NO_QES""DK_MITID""DK_MITID_ERHVERV""FI_FTN""NL_IDIN"
twoStepVerification*|

Two-step verification: NONE, SMS_BEFORE_SIGNING, EMAIL_BEFORE_SIGNING, or BANKID_BEFORE_SIGNING

Value in"NONE""PIN_BEFORE_SIGNING""SMS_BEFORE_SIGNING""EMAIL_BEFORE_SIGNING""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"
sendStatus*|

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

Value in"NOT_SENT""SENT""DELIVERED""BOUNCED""FAILED"
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 an SSN match to sign and the attempt was refused, because no signature exists; those attempts appear only in the document audit trail.

Example Request
curl -X PATCH 'https://app.sajn.se/api/v1/documents/string/parties/string' \  -H 'authorization: string' \  -H 'Content-Type: application/json' \  -d '{  "role": "SIGNER"}'
Example Response
{  "id": "string",  "documentId": "string",  "email": "user@example.com",  "name": "string",  "phone": "string",  "companyName": "string",  "companyRole": "string",  "companyOrgNumber": "string",  "externalId": "string",  "companyId": "string",  "ssn": "string",  "country": "string",  "role": "SIGNER",  "signingOrder": 0,  "signedAt": "2019-08-24T14:15:22Z",  "readStatus": "NOT_OPENED",  "signingStatus": "NOT_SIGNED",  "deliveryMethod": "EMAIL",  "requiredSignature": "NONE",  "twoStepVerification": "NONE",  "sendStatus": "NOT_SENT",  "identityVerified": true,  "identityMismatch": true}

Was this page helpful?