Send documents for signature from your own system, follow the status and get the signed files back, with no manual work. A REST API with JSON and an access key.
https://{instance}.digisign.space/api/external/v1apiKey: …The document is generated in your system and goes out for signature with no manual work.
createYour system is notified of every status change (callbackUrl), or checks the status itself.
statusThe signed document is downloaded and stored in your archive or the employee file.
downloadSignedAt UniCredit Bulbank the process is fully automated: from generating the documents, through sending them for signature, to storing them in an archive system.
The story (in Bulgarian)The key (apiKey) is provided by the DigiSign administrator for your application.
Every customer has their own application: replace {instance} with yours.
Every request carries the key in the apiKey header.
curl "https://{instance}.digisign.space/api/external/v1/settings/channels" \
-H "apiKey: YOUR_API_KEY"Document types and signing channels set up in your application.
GET/settings/typesOfDocuments
Returns the document types configured in DigiSign.
No parameters.
curl "https://{instance}.digisign.space/api/external/v1/settings/typesOfDocuments" \
-H "apiKey: YOUR_API_KEY"{
"documentTypes": [
{
"id": 0,
"shortName": "string",
"name": "string",
"description": "string",
"active": true
}
]
}200401
GET/settings/channels
Returns the signing channels, whether they are enabled and have signatures left in the packages, the tablets (Signatus) and the people set up for automatic signing (B-Trust).
No parameters.
curl "https://{instance}.digisign.space/api/external/v1/settings/channels" \
-H "apiKey: YOUR_API_KEY"{
"channels": [
{
"id": "BTRUST",
"name": "string",
"priority": 0,
"enabled": true,
"hasAvailableSignings": true,
"oneTimeSigning": true,
"signatusDevices": [
{
"deviceId": "string",
"location": "string",
"name": "string",
"enabled": true
}
],
"autoSigners": [
{
"identifier": "string",
"names": "string"
}
]
}
]
}200401
Create, update, check, download and cancel signature requests; 1-Click-Sign codes.
POST/signRequests/create
Creates a request with one or more documents (PDF or XML, base64) and the signers in the order they must sign. It can set a deadline, a reminder, a folder, tags, an email for the signed file and an address to call when the status changes.
| Field | Type | Description |
|---|---|---|
typerequired | integer | Type ID of document in sign request |
descriptionrequired | string | Description of the document |
employeeNumber | string | Employee ID of registered DigiSign user. Used only if the sign request must be associated with specific user (and to be visible in their respective "My Documents" view) |
documentsrequired | DocumentData[] | |
participants | SigningParticipantData[] | List of participants in the signing process. The order of the elements of the list is strictly observed in the signing process. |
expiry | string | Deadline to sign document(s). Format yyyy-MM-dd HH:mm:ss |
expirationNotification | integer | Number of hours before expiry to send reminder. Reminders templates are configured in the Settings of the DigiSign Document Portal. |
autoprocess | boolean | True if the signing process must be initiated automatically by the timer (within 5 min). False if the process will be started manually from the DigiSign Document Portal UI. |
processNow | boolean | True if the signing process must be initiated immediately. |
sendSignedFileTo | string | E-mail address where to send the document after the process is completed and all participant have applied their respective digital signatures. Comma separated list of e-mail addresses. Supported delimiters ',' and ';' |
passwordForSendSignedFileTo | string | Password to protect the ZIP archive with documents sent to the [sendSignedFileTo]. If value is null or empty documents will be sent without protection. |
folderName | string | Full name of the folder to upload the document into or path to the folder. The path to the folder starts from '/' (main folder) and is separated by '/'. If the value is not specified or its '/' or folder is not found the document will be uploaded into the main folder. If only a single name is passed, the first found folder with this name will be used. |
tags | [] | Array of tags to be added to the document (for search) |
callbackUrl | string | Callback URL that will be called by the DigiSign portal when the status of the signing request changes. (Http method: GET) |
{
"type": 0,
"description": "string",
"employeeNumber": "string",
"documents": [
{
"fileName": "string",
"content": "string",
"sha256sum": "string"
}
],
"participants": [
{
"names": "string",
"email": "string",
"phone": "string",
"ipAddress": "string",
"typeOfIdentifier": "EGN",
"identifier": "string",
"channel": "BTRUST",
"signatureVendorAlias": "string",
"billingMode": "RELYING_PARTY",
"oneTimeSigning": true,
"oneTimeRecipient": {
"country": "string",
"identificationNumber": "string",
"documentNumber": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"phone": "string",
"email": "string",
"language": "bg",
"codeConfirmation": "VENDOR",
"personIdentifierType": "EGN",
"personDocumentType": "ID_CARD",
"firstNameCyrillic": "string",
"middleNameCyrillic": "string",
"lastNameCyrillic": "string",
"birthCountryCode": "string",
"birthDate": "string",
"documentIssueDate": "string",
"documentValidityDate": "string",
"personAddress": {
"address": "string",
"city": "string",
"countryCode": "string"
},
"oneTimeOTPLINK": "OTP"
},
"oneTimeAgent": {
"country": "string",
"identificationNumber": "string",
"phone": "string"
},
"signAllDocumentsAtOnce": true,
"signaturePositions": [
{
"fileName": "string",
"pageNum": 0,
"xAxis": 0,
"yAxis": 0
}
],
"signingProperties": [
{
"fileName": "string",
"optional": true,
"preview": true,
"visibleSignature": true
}
],
"deviceId": "string",
"protectionMode": "none",
"linkPassword": "string",
"autoSignerId": "string",
"coverage": 0,
"annotations": [
{
"fileName": "string",
"annotationText": "string",
"pageNum": 0,
"xAxis": 0,
"yAxis": 0,
"fontName": "string",
"fontSize": 0,
"fontColor": "string"
}
],
"visualSignVariant": "DIGISIGN",
"autoprocess": true,
"signedDeclaration": "string",
"employee": {
"email": "string",
"employeeId": "string",
"fullNameCyrillic": "string",
"fullNameLatin": "string",
"phone": "string",
"position": "string"
},
"sendSignedFile": true,
"passwordSendSignedFile": "string"
}
],
"expiry": "string",
"expirationNotification": 0,
"autoprocess": true,
"processNow": true,
"sendSignedFileTo": "string",
"passwordForSendSignedFileTo": "string",
"folderName": "string",
"tags": [
null
],
"callbackUrl": "string"
}curl -X POST "https://{instance}.digisign.space/api/external/v1/signRequests/create" \
-H "apiKey: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d @request.json{
"unid": "string",
"status": "Waiting",
"totalParticipants": 0,
"signedParticipants": 0,
"errorMessage": "string",
"success": true
}200401404
PUT/signRequests/update
Updates a request and starts the signing process.
| Field | Type | Description |
|---|---|---|
unidrequired | string | UNID of sign request |
participants | SigningParticipantUpdateData[] | Signing participants with new signature positions |
expiry | string | Deadline to sign document(s). Format yyyy-MM-dd HH:mm:ss |
processNow | boolean | True if the signing process must be initiated immediately. |
{
"unid": "string",
"participants": [
{
"identifier": "string",
"signaturePositions": [
{
"fileName": "string",
"pageNum": 0,
"xAxis": 0,
"yAxis": 0
}
],
"visualSignVariant": "DIGISIGN"
}
],
"expiry": "string",
"processNow": true
}curl -X PUT "https://{instance}.digisign.space/api/external/v1/signRequests/update" \
-H "apiKey: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d @request.json{
"unid": "string",
"status": "Waiting",
"totalParticipants": 0,
"signedParticipants": 0,
"errorMessage": "string",
"success": true
}200401404
GET/signRequests/status
Returns the status of the request and how many participants have signed. Optionally checks the status with the provider first.
| Field | Type | Description |
|---|---|---|
unidrequired | string | UNID of sign request |
forceCheck | boolean | Force check the request status in DigiSign Gateway and update in portal (if needed) before returning the result. Force check will be executed only when 'forceCheck' is 'true' and status in portal is 'Processing' |
curl "https://{instance}.digisign.space/api/external/v1/signRequests/status?unid=REQUEST_UNID" \
-H "apiKey: YOUR_API_KEY"{
"unid": "string",
"status": "Waiting",
"totalParticipants": 0,
"signedParticipants": 0,
"errorMessage": "string",
"success": true
}200401404
GET/signRequests/downloadSigned
Returns the signed files. Optionally deletes them from DigiSign after a successful download.
| Field | Type | Description |
|---|---|---|
unidrequired | string | UNID of sign request |
deleteDocument | boolean | Delete document from DigiSign after successful download. |
curl "https://{instance}.digisign.space/api/external/v1/signRequests/downloadSigned?unid=REQUEST_UNID" \
-H "apiKey: YOUR_API_KEY"{
"unid": "string",
"status": "Waiting",
"errorMessage": "string",
"success": true,
"documents": [
{
"fileName": "string",
"content": "string",
"sha256sum": "string"
}
]
}200401404
POST/signRequests/cancel
Withdraws a signature request.
| Field | Type | Description |
|---|---|---|
unidrequired | string | UNID of the sign request |
reason | string | Reason for the cancellation. Will be set in processing signing participant |
{
"unid": "string",
"reason": "string"
}curl -X POST "https://{instance}.digisign.space/api/external/v1/signRequests/cancel" \
-H "apiKey: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d @request.json{
"unid": "string",
"status": "Waiting",
"errorMessage": "string",
"success": true
}200400401404
POST/signRequests/validateOtp
Checks the code the current signer has received.
| Field | Type | Description |
|---|---|---|
unidrequired | string | UNID of the sign request |
otpCoderequired | string | OTP code received from vendor |
phone | string | Optional parameter. Phone number of the current signing party. If specified will be checked against current signing party phone number. Format "+[0-9]". |
{
"unid": "string",
"otpCode": "string",
"phone": "string"
}curl -X POST "https://{instance}.digisign.space/api/external/v1/signRequests/validateOtp" \
-H "apiKey: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d @request.json{
"success": true,
"remainingAttempts": 0,
"details": "string"
}200400401404
POST/signRequests/resendOtp
Sends the code to the current signer again.
| Field | Type | Description |
|---|---|---|
unidrequired | string | UNID of the sign request |
phone | string | Optional parameter. Phone number of the current signing party. If specified will be checked against current signing party phone number. Format "+[0-9]". |
{
"unid": "string",
"phone": "string"
}curl -X POST "https://{instance}.digisign.space/api/external/v1/signRequests/resendOtp" \
-H "apiKey: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d @request.json{
"success": true,
"details": "string"
}200400401404
200400401403404Field descriptions are in English, as in the technical specification.
Questions about the integration: write to support@digisign.space.