Update a party

curl --request PATCH \
  --url https://app.sajn.se/api/v1/documents/{id}/parties/{partyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '
{
  "role": "SIGNER",
  "name": "<string>",
  "email": "[email protected]",
  "phone": "<string>",
  "companyName": "<string>",
  "companyRole": "<string>",
  "companyOrgNumber": "<string>",
  "externalId": "<string>",
  "companyId": "<string>",
  "ssn": "<string>",
  "country": "<string>",
  "signingOrder": 123
}
'

import requests

url = "https://app.sajn.se/api/v1/documents/{id}/parties/{partyId}"

payload = {
    "role": "SIGNER",
    "name": "<string>",
    "email": "[email protected]",
    "phone": "<string>",
    "companyName": "<string>",
    "companyRole": "<string>",
    "companyOrgNumber": "<string>",
    "externalId": "<string>",
    "companyId": "<string>",
    "ssn": "<string>",
    "country": "<string>",
    "signingOrder": 123
}
headers = {
    "authorization": "<authorization>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    authorization: '<authorization>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    role: 'SIGNER',
    name: '<string>',
    email: '[email protected]',
    phone: '<string>',
    companyName: '<string>',
    companyRole: '<string>',
    companyOrgNumber: '<string>',
    externalId: '<string>',
    companyId: '<string>',
    ssn: '<string>',
    country: '<string>',
    signingOrder: 123
  })
};

fetch('https://app.sajn.se/api/v1/documents/{id}/parties/{partyId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.sajn.se/api/v1/documents/{id}/parties/{partyId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'role' => 'SIGNER',
    'name' => '<string>',
    'email' => '[email protected]',
    'phone' => '<string>',
    'companyName' => '<string>',
    'companyRole' => '<string>',
    'companyOrgNumber' => '<string>',
    'externalId' => '<string>',
    'companyId' => '<string>',
    'ssn' => '<string>',
    'country' => '<string>',
    'signingOrder' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sajn.se/api/v1/documents/{id}/parties/{partyId}"

	payload := strings.NewReader("{\n  \"role\": \"SIGNER\",\n  \"name\": \"<string>\",\n  \"email\": \"[email protected]\",\n  \"phone\": \"<string>\",\n  \"companyName\": \"<string>\",\n  \"companyRole\": \"<string>\",\n  \"companyOrgNumber\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"companyId\": \"<string>\",\n  \"ssn\": \"<string>\",\n  \"country\": \"<string>\",\n  \"signingOrder\": 123\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("authorization", "<authorization>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://app.sajn.se/api/v1/documents/{id}/parties/{partyId}")
  .header("authorization", "<authorization>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"role\": \"SIGNER\",\n  \"name\": \"<string>\",\n  \"email\": \"[email protected]\",\n  \"phone\": \"<string>\",\n  \"companyName\": \"<string>\",\n  \"companyRole\": \"<string>\",\n  \"companyOrgNumber\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"companyId\": \"<string>\",\n  \"ssn\": \"<string>\",\n  \"country\": \"<string>\",\n  \"signingOrder\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.sajn.se/api/v1/documents/{id}/parties/{partyId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["authorization"] = '<authorization>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"role\": \"SIGNER\",\n  \"name\": \"<string>\",\n  \"email\": \"[email protected]\",\n  \"phone\": \"<string>\",\n  \"companyName\": \"<string>\",\n  \"companyRole\": \"<string>\",\n  \"companyOrgNumber\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"companyId\": \"<string>\",\n  \"ssn\": \"<string>\",\n  \"country\": \"<string>\",\n  \"signingOrder\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "documentId": "<string>",
  "name": "<string>",
  "role": "SIGNER",
  "signedAt": "2023-11-07T05:31:56Z",
  "readStatus": "NOT_OPENED",
  "signingStatus": "NOT_SIGNED",
  "deliveryMethod": "EMAIL",
  "requiredSignature": "NONE",
  "twoStepVerification": "NONE",
  "sendStatus": "NOT_SENT",
  "identityVerified": true,
  "identityMismatch": true,
  "email": "[email protected]",
  "phone": "<string>",
  "companyName": "<string>",
  "companyRole": "<string>",
  "companyOrgNumber": "<string>",
  "externalId": "<string>",
  "companyId": "<string>",
  "ssn": "<string>",
  "country": "<string>",
  "signingOrder": 123
}

{
  "message": "<string>",
  "code": "<string>",
  "errorId": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>"
    }
  ],
  "requiredScopes": [
    "<string>"
  ],
  "grantedScopes": [
    "<string>"
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "errorId": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>"
    }
  ],
  "requiredScopes": [
    "<string>"
  ],
  "grantedScopes": [
    "<string>"
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "errorId": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>"
    }
  ],
  "requiredScopes": [
    "<string>"
  ],
  "grantedScopes": [
    "<string>"
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "errorId": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>"
    }
  ],
  "requiredScopes": [
    "<string>"
  ],
  "grantedScopes": [
    "<string>"
  ]
}

Document Parties

Update a party

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.

PATCH

api

documents

{id}

parties

{partyId}

Update a party

curl --request PATCH \
  --url https://app.sajn.se/api/v1/documents/{id}/parties/{partyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '
{
  "role": "SIGNER",
  "name": "<string>",
  "email": "[email protected]",
  "phone": "<string>",
  "companyName": "<string>",
  "companyRole": "<string>",
  "companyOrgNumber": "<string>",
  "externalId": "<string>",
  "companyId": "<string>",
  "ssn": "<string>",
  "country": "<string>",
  "signingOrder": 123
}
'

import requests

url = "https://app.sajn.se/api/v1/documents/{id}/parties/{partyId}"

payload = {
    "role": "SIGNER",
    "name": "<string>",
    "email": "[email protected]",
    "phone": "<string>",
    "companyName": "<string>",
    "companyRole": "<string>",
    "companyOrgNumber": "<string>",
    "externalId": "<string>",
    "companyId": "<string>",
    "ssn": "<string>",
    "country": "<string>",
    "signingOrder": 123
}
headers = {
    "authorization": "<authorization>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    authorization: '<authorization>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    role: 'SIGNER',
    name: '<string>',
    email: '[email protected]',
    phone: '<string>',
    companyName: '<string>',
    companyRole: '<string>',
    companyOrgNumber: '<string>',
    externalId: '<string>',
    companyId: '<string>',
    ssn: '<string>',
    country: '<string>',
    signingOrder: 123
  })
};

fetch('https://app.sajn.se/api/v1/documents/{id}/parties/{partyId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.sajn.se/api/v1/documents/{id}/parties/{partyId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'role' => 'SIGNER',
    'name' => '<string>',
    'email' => '[email protected]',
    'phone' => '<string>',
    'companyName' => '<string>',
    'companyRole' => '<string>',
    'companyOrgNumber' => '<string>',
    'externalId' => '<string>',
    'companyId' => '<string>',
    'ssn' => '<string>',
    'country' => '<string>',
    'signingOrder' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sajn.se/api/v1/documents/{id}/parties/{partyId}"

	payload := strings.NewReader("{\n  \"role\": \"SIGNER\",\n  \"name\": \"<string>\",\n  \"email\": \"[email protected]\",\n  \"phone\": \"<string>\",\n  \"companyName\": \"<string>\",\n  \"companyRole\": \"<string>\",\n  \"companyOrgNumber\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"companyId\": \"<string>\",\n  \"ssn\": \"<string>\",\n  \"country\": \"<string>\",\n  \"signingOrder\": 123\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("authorization", "<authorization>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://app.sajn.se/api/v1/documents/{id}/parties/{partyId}")
  .header("authorization", "<authorization>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"role\": \"SIGNER\",\n  \"name\": \"<string>\",\n  \"email\": \"[email protected]\",\n  \"phone\": \"<string>\",\n  \"companyName\": \"<string>\",\n  \"companyRole\": \"<string>\",\n  \"companyOrgNumber\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"companyId\": \"<string>\",\n  \"ssn\": \"<string>\",\n  \"country\": \"<string>\",\n  \"signingOrder\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.sajn.se/api/v1/documents/{id}/parties/{partyId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["authorization"] = '<authorization>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"role\": \"SIGNER\",\n  \"name\": \"<string>\",\n  \"email\": \"[email protected]\",\n  \"phone\": \"<string>\",\n  \"companyName\": \"<string>\",\n  \"companyRole\": \"<string>\",\n  \"companyOrgNumber\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"companyId\": \"<string>\",\n  \"ssn\": \"<string>\",\n  \"country\": \"<string>\",\n  \"signingOrder\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "documentId": "<string>",
  "name": "<string>",
  "role": "SIGNER",
  "signedAt": "2023-11-07T05:31:56Z",
  "readStatus": "NOT_OPENED",
  "signingStatus": "NOT_SIGNED",
  "deliveryMethod": "EMAIL",
  "requiredSignature": "NONE",
  "twoStepVerification": "NONE",
  "sendStatus": "NOT_SENT",
  "identityVerified": true,
  "identityMismatch": true,
  "email": "[email protected]",
  "phone": "<string>",
  "companyName": "<string>",
  "companyRole": "<string>",
  "companyOrgNumber": "<string>",
  "externalId": "<string>",
  "companyId": "<string>",
  "ssn": "<string>",
  "country": "<string>",
  "signingOrder": 123
}

{
  "message": "<string>",
  "code": "<string>",
  "errorId": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>"
    }
  ],
  "requiredScopes": [
    "<string>"
  ],
  "grantedScopes": [
    "<string>"
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "errorId": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>"
    }
  ],
  "requiredScopes": [
    "<string>"
  ],
  "grantedScopes": [
    "<string>"
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "errorId": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>"
    }
  ],
  "requiredScopes": [
    "<string>"
  ],
  "grantedScopes": [
    "<string>"
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "errorId": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>"
    }
  ],
  "requiredScopes": [
    "<string>"
  ],
  "grantedScopes": [
    "<string>"
  ]
}

You’re viewing API version 2026-09, which is deprecated and stops working on October 1, 2027. To see the current version, select 2026-10 in the menu at the top of the sidebar. To move your integration, see Upgrading to 2026-10.

Authorizations

Authorization

string

header

required

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

Headers

authorization

string

required

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.

Maximum string length: 255

Path Parameters

string

required

partyId

string

required

Body

application/json

Body

role

any

default:SIGNER

required

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

name

string

string<email>

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

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)

signingOrder

number | null

deliveryMethod

enum<string>

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

Available options:

EMAIL,

SMS,

NONE,

IN_APP

requiredSignature

enum<string>

Signature type required: DRAWING, BANKID, or CLICK_TO_SIGN

Available options:

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

enum<string>

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

Available options:

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

string

required

Unique signer identifier

documentId

string

required

Document ID this signer belongs to

name

string

required

Signer full name

role

enum<string>

required

Signer role: SIGNER, ORGANIZER, or REVIEWER

Available options:

SIGNER,

ORGANIZER,

REVIEWER

signedAt

string<date-time> | null

required

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

readStatus

enum<string>

required

Read status: NOT_OPENED, OPENED, or READ

Available options:

NOT_OPENED,

OPENED,

READ

signingStatus

enum<string>

required

Signing status: NOT_SIGNED, SIGNED, or REJECTED

Available options:

NOT_SIGNED,

SIGNED,

REJECTED

deliveryMethod

enum<string> | null

required

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

Available options:

EMAIL,

SMS,

NONE,

IN_APP

requiredSignature

enum<string> | null

required

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

Available options:

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

enum<string> | null

required

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

Available options:

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

enum<string> | null

required

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

Available options:

NOT_SENT,

SENT,

DELIVERED,

BOUNCED,

FAILED

identityVerified

boolean

required

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

identityMismatch

boolean

required

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.

string<email> | null

Signer email address

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

phone

string | null

Signer phone number (for SMS notifications)

companyName

string | null

Company name

companyRole

string | null

Role/title within the company

companyOrgNumber

string | null

Company organization number

externalId

string | null

Your external reference ID for this signer

companyId

string | null

Linked company ID

ssn

string | null

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

string | null

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

signingOrder

number | null

Order for sequential signing (null for parallel)

Overview

Login

System

Account

Workspaces

Members

Workspace Roles

Documents

Document Parties

Document Comments

Document Chat

Files

Folders

Blocks

Document Signers

Document Approval

Document Fields

Document Tags

Templates

Forms

Contacts

Companies

Tags

Document Categories

Custom Fields

Webhooks

Events

sajn ID

Organization

Helpers

API Reference

Update a party

Authorizations

Headers

Path Parameters

Body

Response