Signicat Sign API (v1)

Download OpenAPI specification:Download

URL: https://developer.signicat.com/docs/support/ License:

The Sign API is an API for managing documents and signing orders as part of Signicat Sign

Getting started with electronic signatures

document

Documents are stored short-term in Signicat's Session Data Storage. Documents are referenced by a documentID.

Get document

Get a document from Signicat's document storage backend

Authorizations:

signrestOauth2Security

path Parameters

documentId

required

string

Responses

Response samples

200
400
404

Content type

application/json

"string"

Delete document

Delete a document from Signicat's document storage backend

Authorizations:

signrestOauth2Security

path Parameters

documentId

required

string

Responses

Response samples

400

Content type

application/json

{"status": 0,
"type": "string",
"title": "string",
"detail": "string"
}

Upload session document

Upload a document to Signicat's session data storage

Authorizations:

signrestOauth2Security

Request Body schema:
application/pdf

string <binary>

Responses

Response samples

201
400
411
415

Content type

application/json

{"documentId": "0807201949xfrupvbzx7o07uihsihsx3xllslasvk8qtaojow3792xjucp"
}

archive-document

Archived documents are stored long-term in Signicat's document archive. Archived documents are referenced by an archiveID.

Get archived document

Get a document from Signicat's document archive

Authorizations:

signrestOauth2Security

path Parameters

archiveId

required

string

Example: 200320193lrce4j85hpgdns4ivbuts5dy7pgarm1e0iozjq4qh2tey77jv

The ID of the document stored in Signicat's document archive.

Responses

Response samples

200

Content type

application/json

"string"

Delete archived document

Delete a document from Signicat's document archive

Authorizations:

signrestOauth2Security

path Parameters

archiveId

required

string

Example: 200320193lrce4j85hpgdns4ivbuts5dy7pgarm1e0iozjq4qh2tey77jv

The ID of the document stored in Signicat's document archive.

Responses

Response samples

404

Content type

application/json

{"status": 0,
"type": "string",
"title": "string",
"detail": "string"
}

signing-order

A signing order represents a single signing process, which can consist of one or more documents and signees

Create signing order

Create a new signing order

Authorizations:

signrestOauth2Security

Request Body schema: application/json
required

clientReference	string [ 1 .. 255 ] characters Example: "b8a5ccdc-d79b-412e-a20e-03c2a8c8cdd2" A client specific reference. This value will not be used by the service, but will be returned to the client.
required	Array of objects (Task) [ 1 .. 2147483647 ] items One or more tasks. See the documentation of the Task data type.
	Array of objects (SigningOrderNotification) [ 1 .. 2147483647 ] items One or more notifications that will be sent when the signing order has been completed
daysUntilDeletion	integer <int32> [ 1 .. 30 ] Example: "7" The number of days before the signing order is automatically deleted from Signicat’s storage, after every task's days-to-live have passed. (see daysToLive on the Task element). Documents in the archive will not be deleted even if the signing order that created the documents is deleted. All documents that are not in the archive will be deleted.
	Array of objects (PackagingTask) [ 1 .. 2147483647 ] items
	Array of objects (NotificationTemplateParams) [ 1 .. 2147483647 ] items A list of template params objects to be used to be used in task notifications of type EMAIL

Responses

Request samples

Payload

Content type

application/json

{"clientReference": "b8a5ccdc-d79b-412e-a20e-03c2a8c8cdd2",
"tasks": [{"id": "b8a5ccdc-d79b-412e-a20e-03c2a8c8cdd2",
"profile": "default",
"language": "nb",
"daysToLive": 7,
"configuration": "pades",
"documents": [{"id": "7f5be5ec-650e-4d6e-9007-e420a7dd81aa",
"description": "Loan agreement",
"action": "SIGN",
"source": "SESSION",
"documentRef": "0807201949xfrupvbzx7o07uihsihsx3xllslasvk8qtaojow3792xjucp",
"externalReference": "427bbe68-a161-11e9-a2a3-2a2ae2dbcce4",
"signTextEntry": "ID: 134256",
"sendResultToArchive": false,
"form": {"interactive": true,
"inputParams": [{"name": "string",
"value": "string"
}
]
}
}
],
"signatureMethods": [{"name": "nbid-sign",
"type": "SIGNED_STATEMENT",
"handwritten": false
}
],
"authentication": {"methods": ["nbid"
],
"artifact": false
},
"onTaskPostpone": "https://mydomain.com/postpone",
"onTaskComplete": "https://mydomain.com/complete",
"onTaskReject": "https://mydomain.com/reject",
"dialog": {"title": "Signing request",
"message": "Please sign these documents"
},
"notifications": [{"notificationTemplateParamsId": "string",
"id": "c68c7fd4-600c-4e4c-964e-8e8d15a24e61",
"recipient": "noreply@signicat.com",
"sender": "signicat",
"header": "Task completed",
"message": "A task belonging to the signing order with ID ${orderId} has been completed.",
"type": "EMAIL",
"schedule": [{"triggerStatus": "COMPLETED",
"delay": {"minutes": 30,
"hours": 12,
"days": 7
}
}
]
}
],
"signText": "string",
"subject": {"id": "u7s9ccdc-d79b-412e-a20e-03c2a8c8cdd2",
"attributes": [{"name": "national-id",
"value": "10109001290",
"methods": ["nbid-sign"
]
}
],
"loginHints": [{"name": "string",
"value": "string",
"methods": ["string"
]
}
]
},
"dependsOnTasks": ["string"
],
"useLegacyDocumentViewer": false
}
],
"notifications": [{"id": "25e0e0de-a171-11e9-a2a3-2a2ae2dbcce4",
"recipient": "noreply@signicat.com",
"sender": "signicat",
"header": "Signingorder completed",
"message": "Ginny and Tinky have completed their tasks and the signing order with ID ${orderId} is completed.",
"type": "EMAIL"
}
],
"daysUntilDeletion": 7,
"packagingTasks": [{"id": "83241c55-8813-495c-9d2f-390b6a39ea29",
"sendToArchive": true,
"method": "pades",
"notifications": [{"id": "e650b754-21dd-4c82-abc4-6f992bd4c271",
"recipient": "noreply@signicat.com",
"sender": "signicat",
"header": "Packaging task completed.",
"message": "A packaging task has been completed.",
"type": "EMAIL",
"schedule": [{"triggerStatus": "COMPLETED"
}
]
}
],
"documents": [{"taskId": "b8a5ccdc-d79b-412e-a20e-03c2a8c8cdd2",
"documentIds": ["7f5be5ec-650e-4d6e-9007-e420a7dd81aa"
]
}
]
}
],
"notificationTemplateParams": [{"id": "c68c7fd4-600c-4e4c-964e-8e8d15a24e61",
"footer": "Footer text \\n ©Signicat",
"button": "Click here to sign",
"linkText": "You can also copy this link into your browser",
"logoUrl": "https://developer.signicat.com/wp-content/uploads/2020/03/signicat-logo.png"
}
]
}

Response samples

201
400

Content type

application/json

{"id": "string",
"artifact": "9dda9sv2of79fgbwvwvj09w0a",
"clientReference": "b8a5ccdc-d79b-412e-a20e-03c2a8c8cdd2",
"tasks": [{"id": "b8a5ccdc-d79b-412e-a20e-03c2a8c8cdd2",
"profile": "default",
"language": "nb",
"daysToLive": 7,
"configuration": "pades",
"documents": [{"id": "7f5be5ec-650e-4d6e-9007-e420a7dd81aa",
"description": "Loan agreement",
"action": "SIGN",
"source": "SESSION",
"documentRef": "0807201949xfrupvbzx7o07uihsihsx3xllslasvk8qtaojow3792xjucp",
"externalReference": "427bbe68-a161-11e9-a2a3-2a2ae2dbcce4",
"signTextEntry": "ID: 134256",
"sendResultToArchive": false,
"form": {"interactive": true,
"inputParams": [{"name": "string",
"value": "string"
}
]
}
}
],
"signatureMethods": [{"name": "nbid-sign",
"type": "SIGNED_STATEMENT",
"handwritten": false
}
],
"authentication": {"methods": ["nbid"
],
"artifact": false
},
"onTaskPostpone": "https://mydomain.com/postpone",
"onTaskComplete": "https://mydomain.com/complete",
"onTaskReject": "https://mydomain.com/reject",
"dialog": {"title": "Signing request",
"message": "Please sign these documents"
},
"notifications": [{"notificationTemplateParamsId": "string",
"id": "c68c7fd4-600c-4e4c-964e-8e8d15a24e61",
"recipient": "noreply@signicat.com",
"sender": "signicat",
"header": "Task completed",
"message": "A task belonging to the signing order with ID ${orderId} has been completed.",
"type": "EMAIL",
"schedule": [{"triggerStatus": "COMPLETED",
"delay": {"minutes": 30,
"hours": 12,
"days": 7
}
}
]
}
],
"signText": "string",
"subject": {"id": "u7s9ccdc-d79b-412e-a20e-03c2a8c8cdd2",
"attributes": [{"name": "national-id",
"value": "10109001290",
"methods": ["nbid-sign"
]
}
],
"loginHints": [{"name": "string",
"value": "string",
"methods": ["string"
]
}
]
},
"dependsOnTasks": ["string"
],
"signingUrl": "https://preprod.signicat.com/std/docaction/demo?request_id=2509202069ye6tqxwsz50m8of4z21zegn2ukxury1bfbgml8v9dvzlzimd&task_id=b8a5ccdc-d79b-412e-a20e-03c2a8c8cdd2",
"useLegacyDocumentViewer": false
}
],
"notifications": [{"id": "25e0e0de-a171-11e9-a2a3-2a2ae2dbcce4",
"recipient": "noreply@signicat.com",
"sender": "signicat",
"header": "Signingorder completed",
"message": "Ginny and Tinky have completed their tasks and the signing order with ID ${orderId} is completed.",
"type": "EMAIL"
}
],
"daysUntilDeletion": 7,
"packagingTasks": [{"id": "83241c55-8813-495c-9d2f-390b6a39ea29",
"sendToArchive": true,
"method": "pades",
"notifications": [{"id": "e650b754-21dd-4c82-abc4-6f992bd4c271",
"recipient": "noreply@signicat.com",
"sender": "signicat",
"header": "Packaging task completed.",
"message": "A packaging task has been completed.",
"type": "EMAIL",
"schedule": [{"triggerStatus": "COMPLETED"
}
]
}
],
"documents": [{"taskId": "b8a5ccdc-d79b-412e-a20e-03c2a8c8cdd2",
"documentIds": ["7f5be5ec-650e-4d6e-9007-e420a7dd81aa"
]
}
]
}
],
"notificationTemplateParams": [{"id": "c68c7fd4-600c-4e4c-964e-8e8d15a24e61",
"footer": "Footer text \\n ©Signicat",
"button": "Click here to sign",
"linkText": "You can also copy this link into your browser",
"logoUrl": "https://developer.signicat.com/wp-content/uploads/2020/03/signicat-logo.png"
}
]
}

Get signing order

Return the signing order with the given ID

Authorizations:

signrestOauth2Security

path Parameters

orderId

required

string

Responses

Response samples

200
404

Content type

application/json

{"id": "string",
"artifact": "9dda9sv2of79fgbwvwvj09w0a",
"clientReference": "b8a5ccdc-d79b-412e-a20e-03c2a8c8cdd2",
"tasks": [{"id": "b8a5ccdc-d79b-412e-a20e-03c2a8c8cdd2",
"profile": "default",
"language": "nb",
"daysToLive": 7,
"configuration": "pades",
"documents": [{"id": "7f5be5ec-650e-4d6e-9007-e420a7dd81aa",
"description": "Loan agreement",
"action": "SIGN",
"source": "SESSION",
"documentRef": "0807201949xfrupvbzx7o07uihsihsx3xllslasvk8qtaojow3792xjucp",
"externalReference": "427bbe68-a161-11e9-a2a3-2a2ae2dbcce4",
"signTextEntry": "ID: 134256",
"sendResultToArchive": false,
"form": {"interactive": true,
"inputParams": [{"name": "string",
"value": "string"
}
]
}
}
],
"signatureMethods": [{"name": "nbid-sign",
"type": "SIGNED_STATEMENT",
"handwritten": false
}
],
"authentication": {"methods": ["nbid"
],
"artifact": false
},
"onTaskPostpone": "https://mydomain.com/postpone",
"onTaskComplete": "https://mydomain.com/complete",
"onTaskReject": "https://mydomain.com/reject",
"dialog": {"title": "Signing request",
"message": "Please sign these documents"
},
"notifications": [{"notificationTemplateParamsId": "string",
"id": "c68c7fd4-600c-4e4c-964e-8e8d15a24e61",
"recipient": "noreply@signicat.com",
"sender": "signicat",
"header": "Task completed",
"message": "A task belonging to the signing order with ID ${orderId} has been completed.",
"type": "EMAIL",
"schedule": [{"triggerStatus": "COMPLETED",
"delay": {"minutes": 30,
"hours": 12,
"days": 7
}
}
]
}
],
"signText": "string",
"subject": {"id": "u7s9ccdc-d79b-412e-a20e-03c2a8c8cdd2",
"attributes": [{"name": "national-id",
"value": "10109001290",
"methods": ["nbid-sign"
]
}
],
"loginHints": [{"name": "string",
"value": "string",
"methods": ["string"
]
}
]
},
"dependsOnTasks": ["string"
],
"signingUrl": "https://preprod.signicat.com/std/docaction/demo?request_id=2509202069ye6tqxwsz50m8of4z21zegn2ukxury1bfbgml8v9dvzlzimd&task_id=b8a5ccdc-d79b-412e-a20e-03c2a8c8cdd2",
"useLegacyDocumentViewer": false
}
],
"notifications": [{"id": "25e0e0de-a171-11e9-a2a3-2a2ae2dbcce4",
"recipient": "noreply@signicat.com",
"sender": "signicat",
"header": "Signingorder completed",
"message": "Ginny and Tinky have completed their tasks and the signing order with ID ${orderId} is completed.",
"type": "EMAIL"
}
],
"daysUntilDeletion": 7,
"packagingTasks": [{"id": "83241c55-8813-495c-9d2f-390b6a39ea29",
"sendToArchive": true,
"method": "pades",
"notifications": [{"id": "e650b754-21dd-4c82-abc4-6f992bd4c271",
"recipient": "noreply@signicat.com",
"sender": "signicat",
"header": "Packaging task completed.",
"message": "A packaging task has been completed.",
"type": "EMAIL",
"schedule": [{"triggerStatus": "COMPLETED"
}
]
}
],
"documents": [{"taskId": "b8a5ccdc-d79b-412e-a20e-03c2a8c8cdd2",
"documentIds": ["7f5be5ec-650e-4d6e-9007-e420a7dd81aa"
]
}
]
}
],
"notificationTemplateParams": [{"id": "c68c7fd4-600c-4e4c-964e-8e8d15a24e61",
"footer": "Footer text \\n ©Signicat",
"button": "Click here to sign",
"linkText": "You can also copy this link into your browser",
"logoUrl": "https://developer.signicat.com/wp-content/uploads/2020/03/signicat-logo.png"
}
]
}

Delete signing order

Delete an existing signing order

Authorizations:

signrestOauth2Security

path Parameters

orderId

required

string

Responses

Response samples

400

Content type

application/json

{"status": 0,
"type": "string",
"title": "string",
"detail": "string"
}

Get packaging task result document

Get the result document of a packaging task

Authorizations:

signrestOauth2Security

path Parameters

packagingTaskId required	string
orderId required	string

Responses

Response samples

200
400
404

Content type

application/json

"string"

Get packaging task status

Get the status of a packaging task

Authorizations:

signrestOauth2Security

path Parameters

packagingTaskId required	string
orderId required	string

Responses

Response samples

200
404

Content type

application/json

{"orderId": "05022019298twl5n4wo4soavolfwnxev9rxfghqapyk8junju1wxqamkeq",
"packagingTaskId": "f727d294-a3b9-49c7-af99-4a217fc1d8fd",
"packagingTaskStatus": "COMPLETED",
"packagingTaskResultUri": "https://api.signicat.com/enterprise/sign/orders/<SIGNINGORDER-ID>/packaging-tasks/<PACKAGING-TASK-ID>/result"
}

Get the authentication artifact for a task

Generate the value of the authentication artifact. Replaces the old artifact if one exists.

Authorizations:

signrestOauth2Security

path Parameters

taskId required	string
orderId required	string

Responses

Response samples

200
400

Content type

application/json

{"artifact": "brcbedszcdzl040nuhn9wmh9g",
"orderId": "05022019298twl5n4wo4soavolfwnxev9rxfghqapyk8junju1wxqamkeq",
"taskId": "537c8bf6-9b02-49d7-97d1-8d7ad2be36bf",
"signingUrl": "https://preprod.signicat.com/std/docaction/demo?request_id=2509202069ye6tqxwsz50m8of4z21zegn2ukxury1bfbgml8v9dvzlzimd&task_id=b8a5ccdc-d79b-412e-a20e-03c2a8c8cdd2?artifact=brcbedszcdzl040nuhn9wmh9g"
}

Get generated document

Get a generated document from Signicat's document storage

Authorizations:

signrestOauth2Security

path Parameters

documentId required	string
taskId required	string
orderId required	string

Responses

Response samples

200
400
404

Content type

application/json

"string"

Get original document

Get an original document from Signicat's document storage

Authorizations:

signrestOauth2Security

path Parameters

documentId required	string
taskId required	string
orderId required	string

Responses

Response samples

200
400
404

Content type

application/json

"string"

Get signed document

Get a signed document from Signicat's document storage

The signing result

Authorizations:

signrestOauth2Security

path Parameters

documentId required	string
taskId required	string
orderId required	string

Responses

Response samples

200
400
404

Content type

application/json

"string"

Get a list of task events

Get a list of events that have occurred on a task

Authorizations:

signrestOauth2Security

path Parameters

taskId required	string
orderId required	string

Responses

Response samples

200
404

Content type

application/json

[{"eventType": "notification-sent",
"eventTime": "2019-08-24T14:15:22Z",
"data": "Notification by EMAIL was sent to noreply@signicat.com"
}
]

Get a list describing details on the forwarding of this Task

Return information related to the forwarding of this task

Authorizations:

signrestOauth2Security

path Parameters

taskId required	string
orderId required	string

Responses

Response samples

200
404

Content type

application/json

[{"orderId": "05022019298twl5n4wo4soavolfwnxev9rxfghqapyk8junju1wxqamkeq",
"taskId": "537c8bf6-9b02-49d7-97d1-8d7ad2be36bf",
"originalTaskId": "b8a5ccdc-d79b-412e-a20e-03c2a8c8cdd2",
"forwarderName": "Ola Nordmann",
"forwarderEmail": "olanordmann@example.com",
"recipientName": "Kari Nordmann",
"recipientEmail": "kari@example.com",
"recipientMobile": "+4711223344"
}
]

Get task status

Get signing order task current status

Authorizations:

signrestOauth2Security

path Parameters

taskId required	string
orderId required	string

Responses

Response samples

200
404

Content type

application/json

{"orderId": "05022019298twl5n4wo4soavolfwnxev9rxfghqapyk8junju1wxqamkeq",
"taskId": "537c8bf6-9b02-49d7-97d1-8d7ad2be36bf",
"taskStatus": "COMPLETED",
"clientReference": "d8e75ef7-6b3c-4511-b2ee-2b419a0c5cea",
"clientStatus": "fbcf52a7-a952-41fc-82d9-beefbe094f6f",
"documents": [{"id": "fbcf52a7-a952-41fc-82d9-beefbe094f6f",
"originalUri": "https://api.signicat.com/enterprise/sign/orders/<SIGNINGORDER_ID/tasks/<TASK_ID>/documents/<DOCUMENT-ID>/original",
"generatedUri": "https://api.signicat.com/enterprise/sign/orders/<SIGNINGORDER-ID>/tasks/<TASK-ID>/documents/<DOCUMENT-ID>/generated",
"resultUri": "https://api.signicat.com/enterprise/sign/orders/<SIGNINGORDER-ID>/tasks/<TASK-ID>/documents/<DOCUMENT-ID>/result",
"formOutputParam": [{"name": "string",
"value": "string"
}
]
}
],
"rejectReason": "The document was written in Klingon, while I only speak Sindarin"
}

Signicat Sign API (v1)

document

Get document

Authorizations:

path Parameters

Responses

Response samples

Delete document

Authorizations:

path Parameters

Responses

Response samples

Upload session document

Authorizations:

Request Body schema: application/pdftext/plaintext/bidxmlapplication/x-ltv-sdoapplication/pdf

Responses

Response samples

archive-document

Get archived document

Authorizations:

path Parameters

Responses

Response samples

Delete archived document

Authorizations:

path Parameters

Responses

Response samples

signing-order

Create signing order

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get signing order

Authorizations:

path Parameters

Responses

Response samples

Delete signing order

Authorizations:

path Parameters

Responses

Response samples

Get packaging task result document

Authorizations:

path Parameters

Responses

Response samples

Get packaging task status

Authorizations:

path Parameters

Responses

Response samples

Get the authentication artifact for a task

Authorizations:

path Parameters

Responses

Response samples

Get generated document

Authorizations:

path Parameters

Responses

Response samples

Get original document

Authorizations:

path Parameters

Responses

Response samples

Get signed document

Authorizations:

path Parameters

Responses

Response samples

Get a list of task events

Authorizations:

path Parameters

Responses

Response samples

Request Body schema:
application/pdf

Request Body schema: application/json
required