/binders

post

Allowed roles: BACKEND
Creates the new Binder

  • Creates full binder with documents, inputs and parties.
  • Note that binder status is still IN_PREPARATION as document(s) need to be uploaded.
get

Allowed roles: BACKEND
List of Binders

get

Allowed roles: FRONTEND (all parties), BACKEND
Retrieves binder

delete

Allowed roles: BACKEND
Deletes binder

patch

Allowed roles: FRONTEND (OWNER only), BACKEND
Updates binder

  • A binder can be updated only when it is in the IN_PREPARATION status.
  • Non-editable parts are: is,status,created(timestamp)
  • Updates comply as per RFC-7396
get

Allowed roles: FRONTEND (all parties), BACKEND
Series of validations (preflight check) is performed on binder with status IN_PREPARATION. Response clearly indicates if binder is ready to be signed or if some changes are still needed before sending INVITATION request.

post

Allowed roles: FRONTEND (OWNER only), BACKEND
Adding party to the binder

patch

Allowed roles: FRONTEND (OWNER only), BACKEND
Update party.

  • A party can be updated only when binder is in the IN_PREPARATION status.
  • Non-editable parts are: id
  • Updates comply as per RFC-7396

delete

Allowed roles: FRONTEND (OWNER only), BACKEND
Delete party.

  • A party can be deleted only when binder is in the IN_PREPARATION status.
  • Owner party cannot be deleted.
post

Allowed roles: FRONTEND (OWNER only), BACKEND
Adds the document to the binder.

put

Allowed roles: FRONTEND (OWNER only), BACKEND
Uploads content of document

patch

Allowed roles: FRONTEND (OWNER only), BACKEND
Update document:

  • A document can be updated only when binder is in the IN_PREPARATION status.
  • Non-editable parts are: id, originalContentChecksum, contentType
  • Updates comply as per RFC-7396
delete

Allowed roles: FRONTEND (OWNER only), BACKEND
Delete document:

  • A document can be deleted only when binder is in the IN_PREPARATION status.
post

Allowed roles: FRONTEND (OWNER only), BACKEND
Adds new input to the given document

patch

Allowed roles: FRONTEND (all parties), BACKEND
Records signature inputs provided by signer. All inputs provided should reference same party (related to 1 signer).

patch

Allowed roles: FRONTEND (OWNER only), BACKEND
Update input.

  • An input can be updated only when binder is in the IN_PREPARATION status.
  • Non-editable parts are: id, host, userAgent, finished, value, status
  • Updates comply as per RFC-7396
delete

Allowed roles: FRONTEND (OWNER only), BACKEND
Delete input.

  • A input can be deleted only when binder is in the IN_PREPARATION status.
get

Allowed roles: FRONTEND (all parties), BACKEND
Retrieves single page in specified format. Only supported format is PNG for now.

post

Allowed roles: FRONTEND (OWNER only), BACKEND
Starts the signing process.

  • Collect signer parties and obtain service tokens from UserService
  • Send invitation emails (exclusion are handled) to EmailService
  • Prepare signature pages and upload those to DocProcessingService
  • Store request in DB and binder status changed to SIGN_IN_PROGRESS (binder is locked for changes)
If recipients list is not provided or is empty all signers (parties with SIGNER role) are notified.

get

Allowed roles: FRONTEND (all parties), BACKEND
Retrives the events registered for the given binder.