Update a signer

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

Updatable Fields:

• name - Signer’s full name
• email - Signer’s email address
• phone - Signer’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 - Signer role (SIGNER, ORGANIZER, REVIEWER, ACCEPTOR)
• signingOrder - Order for sequential signing
• deliveryMethod - How to notify: EMAIL, SMS, or NONE
• requiredSignature - Signature type: DRAWING, BANKID, or CLICK_TO_SIGN
• twoStepVerification - 2FA: NONE or SMS_BEFORE_SIGNING

Restrictions: Cannot update after signer has signed the document.

PATCH /api/v1/documents/{id}/signers/{signerId}

Update a signer

cURL

curl --request PATCH \
  --url https://app.sajn.se/api/v1/documents/{id}/signers/{signerId} \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '
{
  "role": "SIGNER",
  "name": "<string>",
  "email": "[e-mail]",
  "phone": "<string>",
  "companyName": "<string>",
  "companyRole": "<string>",
  "companyOrgNumber": "<string>",
  "externalId": "<string>",
  "companyId": "<string>",
  "ssn": "<string>",
  "signingOrder": 123,
  "deliveryMethod": "EMAIL",
  "requiredSignature": "NONE",
  "twoStepVerification": "NONE"
}
'

200

{
  "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",
  "email": "[e-mail]",
  "phone": "<string>",
  "companyName": "<string>",
  "companyRole": "<string>",
  "companyOrgNumber": "<string>",
  "externalId": "<string>",
  "companyId": "<string>",
  "ssn": "<string>",
  "signingOrder": 123
}

Headers

authorization · string · required

Bearer token for API authentication

Path Parameters

id · string · required

signerId · string · required

Body

application/json

Body

role · enum<string> · default: SIGNER · required

Available options: SIGNER, ORGANIZER, REVIEWER, ACCEPTOR

name · string

email · 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

signingOrder · number | null

deliveryMethod · enum<string>

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

Available options: EMAIL, SMS, NONE

requiredSignature · enum<string>

Signature type required: DRAWING, BANKID, or CLICK_TO_SIGN

Available options: NONE, DRAWING, BANKID, MANUAL, CLICK_TO_SIGN

twoStepVerification · enum<string>

Two-step verification: NONE or SMS_BEFORE_SIGNING

Available options: NONE, SMS_BEFORE_SIGNING, EMAIL_BEFORE_SIGNING

Response

200

application/json

200

id · 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, REVIEWER, or ACCEPTOR

Available options: SIGNER, ORGANIZER, REVIEWER, ACCEPTOR

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

requiredSignature · enum<string> | null · required

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

Available options: NONE, DRAWING, BANKID, MANUAL, CLICK_TO_SIGN

twoStepVerification · enum<string> | null · required

Two-step verification: NONE or SMS_BEFORE_SIGNING

Available options: NONE, SMS_BEFORE_SIGNING, EMAIL_BEFORE_SIGNING

sendStatus · enum<string> | null · required

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

Available options: NOT_SENT, SENT, DELIVERED, BOUNCED, FAILED

email · 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

Swedish personal number (personnummer) - required for BankID signing

signingOrder · number | null

Order for sequential signing (null for parallel)