Signicat
App · 14 actions
Upload documents, manage document collections and signing sessions with Signicat Sign API v2.
Actions
| Action | What it does |
|---|---|
| Cancel signing session | Delete a signing session. |
| Create collection | Create a new document collection. |
| Create signing session | Create a new signing session. |
| Delete collection | Delete a document collection. |
| Delete document | Permanently delete a single document and its metadata. |
| Download document | Retrieve the contents of a stored document as base64. |
| Get collection | Retrieve a document collection. |
| Get document metadata | Retrieve all information stored about a single document. |
| Get signing session | Retrieve a signing session. |
| List signing sessions | Retrieve a paginated list of signing sessions. |
| Merchant sign | Sign document(s) with merchant certificate. |
| Update document metadata | Store optional descriptive data about a stored document. |
| Update signing session | Update an existing signing session. |
| Upload document | Upload a PDF or other document from base64 content. |
Cancel signing session
Delete a signing session.
Inputs
- Signing session
session_idtextRequired - The unique ID of the session.
Outputs
dataobject- Returned value.
Example output
{
"data": {}
}Create collection
Create a new document collection.
Inputs
- Documents
documentslistRequired - Documents.
- Package to
package_tolist - A list of formats the collection should be packaged to when all sessions connected to it are signed.One or more of:
PADES_CONTAINER(Pades container). - Serial signing
serial_signingtrue/false - Whether to enable serial signing for the document collection.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"documents": [],
"id": "example",
"output": {
"packages": [],
"serialSigning": []
},
"packageTo": [],
"serialSigning": false
}
}Create signing session
Create a new signing session.
Inputs
- Title
titletextRequired - Title.
- Document collection ID
document_collection_idtextRequired - Document collection id.
- Document ID
document_idtextRequired - Document id.
- Signing flow
signing_flowtextRequired - Signing flow.One of:
AUTHENTICATION_BASED(Authentication based),PKISIGNING. - Identity provider
identity_providertextRequired - Configured Signicat identity-provider name.
- Due date
due_datedate and time - Due date.
Outputs
datalist- Returned value.
Example output
{
"data": []
}Delete collection
Delete a document collection.
Inputs
- Document collection ID
document_collection_idtextRequired - The unique ID of the document collection.
Outputs
dataobject- Returned value.
Example output
{
"data": {}
}Delete document
Permanently delete a single document and its metadata.
Inputs
- Document ID
document_idtextRequired - The unique ID of the document.
Outputs
dataobject- Returned value.
Example output
{
"data": {}
}Download document
Retrieve the contents of a stored document as base64.
Inputs
- Document ID
document_idtextRequired - Document id.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"content_base64": "example",
"content_type": "example"
}
}Get collection
Retrieve a document collection.
Inputs
- Document collection ID
document_collection_idtextRequired - The unique ID of the document collection.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"documents": [],
"id": "example",
"output": {
"packages": [],
"serialSigning": []
},
"packageTo": [],
"serialSigning": false
}
}Get document metadata
Retrieve all information stored about a single document.
Inputs
- Document ID
document_idtextRequired - The unique ID of the document.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"createdAt": "example",
"description": "example",
"documentHash": {
"hash": "example",
"hashAlgorithm": "SHA256"
},
"documentId": "example",
"filename": "example",
"mimeType": "example",
"title": "example"
}
}Get signing session
Retrieve a signing session.
Inputs
- Signing session
session_idtextRequired - The unique ID of the session.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"archive": {
"archiveTags": [],
"retentionPeriod": "example",
"sendPackagingResultToArchive": false,
"sendSealingResultToArchive": false,
"sendSignatureResultsToArchive": false
},
"documents": [],
"dueDate": "example",
"externalReference": "example",
"forwarding": {
"childSessionIds": [],
"flow": "FORWARD_AND_CONTINUE",
"parentSessionId": "example",
"senderAddress": "example"
},
"id": "example",
"intentionText": {
"format": "TEXT",
"value": "example"
},
"lifecycle": {
"rejectReason": "example",
"state": "BLOCKED",
"stateIsFinal": false
},
"notifications": [],
"output": {
"packages": [],
"seals": [],
"signatures": [],
"userInfo": {
"dateOfBirth": "example",
"extra": {},
"firstName": "example",
"fullName": "example",
"lastName": "example",
"nin": "example",
"signingTime": "example"
}
},
"packageTo": [],
"preAuthentication": {
"enabled": false,
"identityProviders": []
},
"redirectSettings": {
"cancel": "example",
"error": "example",
"reject": "example",
"success": "example"
},
"sealTo": [],
"signText": "example",
"signatureUrl": "example",
"signatureUrlExpiresAt": "example",
"signatureUrlTTL": 1,
"signatureUrlTimeToLive": "example",
"signer": {
"email": "example",
"mobile": "example",
"nationalIdentificationNumber": "example",
"prefill": [],
"username": "example",
"validations": []
},
"signingSetup": [],
"subsequentTo": [],
"title": "example",
"ui": {
"hideWelcomeScreen": false,
"language": "da",
"minimalTextMode": false
},
"usageTags": []
}
}List signing sessions
Retrieve a paginated list of signing sessions.
Inputs
- Offset
offsetnumber - Number of rows to skip before returning results.From 0 to 100000. Default:
0. - Limit
limitnumber - Maximum number of rows to return.From 1 to 1000. Default:
100. - Sort
sortlist - Sorting field. Default value is -createdAt. E.g., +dueDate
- Created date from
created_date_fromdate and time - Filter signing sessions created on or after this date and time
- Created date to
created_date_todate and time - Filter signing sessions created on or before this date and time
- State
statelist - Search field for state. Multiple values allowed. E.g., BLOCKED, READY. See also SessionState enum for possible values.
- Due date from
due_date_fromdate and time - Filter signing sessions with due date on or after this date and time
- Due date to
due_date_todate and time - Filter signing sessions with due date on or before this date and time
- Session title like
session_title_liketext - Filter signing sessions by title using partial text matching (case-insensitive)
Outputs
dataobject- Returned value.
Example output
{
"data": {
"count": 1,
"data": [],
"limit": 1,
"offset": 1,
"total": 1
}
}Merchant sign
Sign document(s) with merchant certificate.
Inputs
- Vendor
vendortextRequired - Vendor.One of:
SBID,NBID. - To be signed documents
to_be_signed_documentslistRequired - To be signed documents.
Outputs
datalist- Returned value.
Example output
{
"data": []
}Update document metadata
Store optional descriptive data about a stored document.
Inputs
- Document ID
document_idtextRequired - The unique ID of the document.
- Filename
filenametext - A name to use if the document is to be stored as a file. Optional metadata about the stored document which the customer can supply.
- Description
descriptiontext - A description of the document for display purposes. Optional metadata about the stored document which the customer can supply.
- Title
titletext - A title of the document for display purposes. Optional metadata about the stored document which the customer can supply.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"createdAt": "example",
"description": "example",
"documentHash": {
"hash": "example",
"hashAlgorithm": "SHA256"
},
"documentId": "example",
"filename": "example",
"mimeType": "example",
"title": "example"
}
}Update signing session
Update an existing signing session.
Inputs
- Signing session
session_idtextRequired - The unique ID of the session.
- Due date
due_datedate and time - Due date.
Outputs
dataobject- Returned value.
Example output
{
"data": {}
}Upload document
Upload a PDF or other document from base64 content.
Inputs
- Content base64
content_base64textRequired - Base64 file content from an earlier step.
- Content type
content_typetextRequired - Content type.One of:
application/pdf,text/plain,application/xml,application/octet-stream.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"createdAt": "example",
"description": "example",
"documentHash": {
"hash": "example",
"hashAlgorithm": "SHA256"
},
"documentId": "example",
"filename": "example",
"mimeType": "example",
"title": "example"
}
}