Add a signer to document

Add a signer/participant to a document. The signer must reference an existing contact.

Signer Roles:

• SIGNER - Must sign the document
• ORGANIZER - Document organizer (no signature required)
• REVIEWER - Reviews document (no signature required)
• ACCEPTOR - Accepts terms (for acceptance documents)

Per-Signer Settings:

• deliveryMethod - How to notify: EMAIL (default), SMS, or NONE (use signing URL directly)
• requiredSignature - Signature type: DRAWING, BANKID, or CLICK_TO_SIGN
• twoStepVerification - 2FA: NONE (default) or SMS_BEFORE_SIGNING

Signing Order: For SEQUENTIAL signing, specify the order (1, 2, 3…). For PARALLEL signing, order is ignored.

Response: Returns the created signer. Use GET /documents/:id/signers/:signerId to retrieve the signing URL.

POST /api/v1/documents/{id}/signers

Add a signer to document

cURL

curl --request POST \
  --url https://app.sajn.se/api/v1/documents/{id}/signers \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '
{
  "contactId": "<string>",
  "role": "SIGNER",
  "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

Body

application/json

Body

Create signer request

contactId · string · required

ID of the contact to add as a signer

Minimum string length: 1

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

Signer role (default: SIGNER)

Available options: SIGNER, ORGANIZER, REVIEWER, ACCEPTOR

signingOrder · number | null

Signing order for sequential signing (ignored for parallel)

deliveryMethod · enum<string>

How to send to this signer: EMAIL (default), SMS, or NONE

Available options: EMAIL, SMS, NONE

requiredSignature · enum<string>

Signature type required: DRAWING (default), BANKID, or CLICK_TO_SIGN

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

twoStepVerification · enum<string>

Two-step verification: NONE (default) 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)