Signers and the signing page
Inviting signers, delivering their links yourself, restricting who can sign, and bringing signers back to your product.
Signers and viewers
Each entry in signers is a SignerInput:
| Field | Description |
|---|---|
email | Required |
role | signer (default) or viewer, who can read but doesn't sign |
personalNumber | Optional. Only the person with this personal identity number, as verified, can sign |
message | Optional message to this signer |
Add more later with POST /documents/{id}/signers.
With a templateId, signers replaces the template's recipients.
Delivering the links
Two ways, per document:
- IDfier emails them:
send=truewhen creating, orPOST /documents/{id}/sendlater. The response'sdeliverysays who was emailed (sent) and who wasn't, with a reason (notSent). - You show them: each signer has a personal
signingUrl. Put it behind a button in your own product, or in your own email.
A signingUrl is personal: give each signer only their own.
Verification
Signers verify their identity before they sign: with the IDfier app, or with
Swedish BankID if your company allows it. Each document lists its
verificationMethods; your company chooses them in IDfier Sign under
Company → API.
Verification level
verificationLevel sets how strongly signers must have verified. Set it when
creating the document; without it, the document gets its template's level, or
government_id.
verificationLevel | Who can sign |
|---|---|
government_id | Anyone verified with IDfier or BankID (default) |
biometric_nfc | Only IDfier Gold: an ID document whose chip was read with NFC, and a face check |
Signers below the level are shown that they can't sign this document. Any
other value gives 400 invalid_verification_level.
Once signed, each signer has a level, their IDfier level at the time:
level | Verified with |
|---|---|
gold | ID chip read with NFC, and a face check |
silver | Swedish BankID |
bronze | Document scan, and a face check |
null | Not known (e.g. signed before levels were recorded) |
The signing page
The signer verifies, reads the document and signs (or declines) on one focused page, without IDfier Sign's workspace around it.
Coming back: returnUrl
With a returnUrl (an https URL), signers go back to your product
afterwards, with two parameters added:
| Parameter | Value |
|---|---|
idfiersign_document | The document id |
idfiersign_status | signed, declined or viewed |
https://yourapp.example/bookings/1042?idfiersign_document=6654…&idfiersign_status=signedUse it to show the right screen, not as proof: anyone can open that URL. Check the document's status with the API before acting on it.
Following the document
Document status | Meaning |
|---|---|
draft | Created, invitations not sent |
in_signature | Waiting for signers |
completed | Everyone signed; /signed-file and /certificate are available |
declined | A signer declined |
void | Cancelled with POST /documents/{id}/void |
Each signer has its own status: pending, accepted, signed, declined
or revoked, and signingMethod once signed. /signed-file returns 409
until the document is completed.