IDfier Developers

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:

FieldDescription
emailRequired
rolesigner (default) or viewer, who can read but doesn't sign
personalNumberOptional. Only the person with this personal identity number, as verified, can sign
messageOptional message to this signer

Add more later with POST /documents/{id}/signers. With a templateId, signers replaces the template's recipients.

Two ways, per document:

  • IDfier emails them: send=true when creating, or POST /documents/{id}/send later. The response's delivery says 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 with IDfier: an ID document and a face check in the IDfier app. Each document lists its verificationMethods; your company chooses them in IDfier Sign under Company → API.

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:

ParameterValue
idfiersign_documentThe document id
idfiersign_statussigned, declined or viewed
https://yourapp.example/bookings/1042?idfiersign_document=6654…&idfiersign_status=signed

Use 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 statusMeaning
draftCreated, invitations not sent
in_signatureWaiting for signers
completedEveryone signed; /signed-file and /certificate are available
declinedA signer declined
voidCancelled 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.

On this page