24.0.0 API Changelog

Breaking changes

• Photo must be uploaded using the correct endpoint. This affects endpoints POST /users and PUT /users/:id - there the specified file hash in the photo object must be obtained from endpoint POST /files/photo. In case the photo is uploaded and used at once (e.g. PUT /configuration/images), nothing changes. Also one photo file hash cannot be used more then once.

• Signatures and initials must be uploaded using the correct endpoint, that is POST /files/signature and POST /files/initials for internal user, and POST /share/upload/initials and POST/share/upload/signature for the external one. Otherwise they will not be able to be assigned to the internal user (using POST /configuration/images or PUT /users/:id/upload), nor will be able to be used during the signing (this applies to external user as well).

• Stamp for the internal user must be uploaded using the general endpoint POST /files/saveFile. For the external recipient, there is a new endpoint POST /share/upload/stamp and the stamp must be uploaded using this endpoint, otherwise the stamp won't be usable for signing.

• When creating a new document definition (endpoint POST /definitions/documents/name) where is the property templateFile specified; and when this property is replaced using the endpoint PUT /definitions/documents/:name, it will be necessary to use newly uploaded, not used file.

• All photos used in contacts have to be unique, unused and uploaded using the endpoint POST /files/photo. This affects endpoints POST /contacts and PUT /contacts.

• All photos used in enums have to be unique, unused and uploaded using the endpoint POST /files/photo. All other files used in enums have to be unique, unused and uploaded using the endpoint POST /files/saveFile. This affects endpoints POST /enums and PUT /enums/:name/record.

• Templates no longer receive property thumbnail, it will be created automatically.

• Property file specified in a template has to be either unused, unique file hash (uploaded using POST /files/saveFile), or there must be specified body boolean property cloneFile in the request. This affects endpoint POST /templates and PUT /templates.

• Drafts no longer receive properties barcode and thumbnails. This affects endpoints POST /drafts and PUT /drafts/:id/:version.

• Endpoint PUT /drafts/:id/:version now accepts body boolean properties cloneMainFile and cloneFiles. These work in the same way as in the endpoint POST /drafts.

• In the endpoints PUT /documents/:version and PUT /documents/edit/:version all the newly specified attachments (path body.file in the content body) must be unused files, or used in a draft only. Additionally, if the main file is changed (only for external documents, path body.pdfFile in the content body), it must be an unused file, or used in a draft only.

• In the endpoints POST /documents and POST /documents/bulk/create all specified attachments (path body.file in the content body) must be unused files, or used in a draft only, or the property optionalData.cloneFiles must be set to true. Additionally, if the main file is specified (only for external documents, path body.pdfFile, or body.bulkFiles in the content body), it must be an unused file, or used in a draft only, or the property optionalData.cloneMainFile must be set to true.

• In all signature / annotate / WF execute endpoints the specified signature data must comply with the following:

  • All specified signatures (in the signatures field) must be uploaded using the correct endpoint (POST /files/signature for the internal user or POST /share/upload/signature for the external recipient).

  • All specified initials (in the signatures field) must be uploaded using the correct endpoint (POST /files/initials for the internal user or POST /share/upload/initials for the external recipient).

  • All specified stamps (in the signatures field) must be uploaded using the correct endpoint (POST /files/saveFile for the internal user or POST /share/upload/stamp for the external recipient).

  • All specified images (in the images field) must be unused files uploaded using the correct endpoint (POST /files/saveFile for the internal user or POST /share/upload/file for the external recipient), or it must be an exiting document barcode file. Same file hashes in a single request call are allowed.

  • These changes affects the following endpoints: POST /documents, POST /documents/bulk/create, PUT /documents/:version, PUT /documents/sign/:version, PUT /documents/annotate/:version, POST /share, POST /share/execute, PUT /share/document/sign/:version, PUT /share/reject and POST /inbox/action.

Counters

• Endpoint PUT /counters can be used only by super-admin.

Non-Breaking changes

Shares

Endpoint POST /share now accepts an optional property oauthFactors (path data[*] in content body) with structure [{ type: string, value: string }].

• It can be used to require one or more of the UAE Pass verification factors (email, phoneNumber, emiratesId).

• When not specified, defaults to email factor only.

• When the email factor is specified, the value must match the recipient’s email.

• Other than email factors can be specified only when the allowedOAuths array contains the value uaePass only.

• All the specified factors are checked.

Endpoint PUT /share now accepts the optional array oauthFactors (path data[*] in content body), serves for editing the UAE Pass verification factors. Same constrains as above applies.

Endpoint PUT /share/delegate now accepts the optional array oauthFactors (in root of the content body object) to update the UAE Pass verification factors in case of the document delegation to the other external recipient. When not specified, it will delegate with email factor only.