Skip to main content
API docs by Redocly

Signicat Sign API v2 (0.0.1)

Download OpenAPI specification:Download

API Support: support@signicat.com URL: https://developer.signicat.com/docs/support/ License: Signicat AS

Documents

Upload a new document

Uploads the document as a binary stream; MIME type is defined by the Content-Type header. The response will be the resulting document reference.

Authorizations:
bearerAuth
header Parameters
Content-Type
required
string

Content type header

Request Body schema:
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "mimeType": "application/pdf",
  • "documentId": "d1234567-89ab-cdef-0123-456789abcdef",
  • "createdAt": "2023-04-12T10:30:00Z",
  • "documentHash": {
    },
  • "filename": "invoice_001.pdf",
  • "description": "Invoice for order #001",
  • "title": "Invoice #001"
}

Retrieve a single document

Authorizations:
bearerAuth
path Parameters
documentId
required
string <uuid>

Document ID parameter

Responses

Response samples

Content type
application/problem+json
{
  • "status": 404,
  • "type": "https://exceptionwiki",
  • "title": "Could not find document\"",
  • "code": "document_not_found"
}

Permanently delete a single document and its metadata

Authorizations:
bearerAuth
path Parameters
documentId
required
string <uuid>

Document ID parameter

Responses

Response samples

Content type
application/problem+json
{}

Store optional descriptive data about a stored document

Authorizations:
bearerAuth
path Parameters
documentId
required
string <uuid>

Document ID parameter

Request Body schema: application/json
required
filename
string

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
string

A description of the document for display purposes. Optional metadata about the stored document which the customer can supply.

title
string

A title of the document for display purposes. Optional metadata about the stored document which the customer can supply.

Responses

Request samples

Content type
application/json
{
  • "filename": "invoice_001.pdf",
  • "description": "Invoice for order #001",
  • "title": "Invoice #001"
}

Response samples

Content type
application/problem+json
{}

Retrieve all information stored about a single document

Authorizations:
bearerAuth
path Parameters
documentId
required
string <uuid>

Document ID parameter

Responses

Response samples

Content type
application/json
{
  • "mimeType": "application/pdf",
  • "documentId": "d1234567-89ab-cdef-0123-456789abcdef",
  • "createdAt": "2023-04-12T10:30:00Z",
  • "documentHash": {
    },
  • "filename": "invoice_001.pdf",
  • "description": "Invoice for order #001",
  • "title": "Invoice #001"
}

Archive

Retrieve an archived document

Authorizations:
bearerAuth
path Parameters
archiveDocumentId
required
string <uuid>

Archive document ID parameter

Responses

Response samples

Content type
application/problem+json
{
  • "status": 404,
  • "type": "https://exceptionwiki",
  • "title": "Could not find document in archive",
  • "code": "archived_document_not_found"
}

Document Collection

Create a new document collection

Creates new document collection.

Authorizations:
bearerAuth
Request Body schema: application/json
required
required
Array of objects (DocumentReference) non-empty
Array (non-empty)
documentId
required
string <uuid>

Docstore document ID

description
string

Responses

Request samples

Content type
application/json
{
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "f05d0dce-a7af-432b-b6b8-e455ab7c0858",
  • "documents": [
    ]
}

Retrieve a document collection

Returns the document collection with the given ID.

Authorizations:
bearerAuth
path Parameters
documentCollectionId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "f05d0dce-a7af-432b-b6b8-e455ab7c0858",
  • "documents": [
    ]
}

Delete a document collection

Deletes the document collection with the given ID.

Authorizations:
bearerAuth
path Parameters
documentCollectionId
required
string

Responses

Response samples

Content type
application/problem+json
{}

Signing Sessions

Create a new signature session

Creates a new signature session.

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array (non-empty)
object (Recipient)

Recipient of notifications

title
required
string <= 255 characters
signText
string <= 255 characters
dueDate
string <date-time>
required
Array of objects (SessionDocument) non-empty
senderDisplayName
string <= 255 characters

The name of the entity that requested the signature. Displayed while signing.

externalReference
string or null <= 1024 characters

An external reference for this session

required
Array of objects (UserInteractionSetup) <= 1 items

The user interaction setups for this session describing which IDPs are available for the end-user.

subsequentTo
Array of strings <uuid> [ items <uuid > ]

IDs of signing sessions that must be signed before this one.

packageTo
Array of strings (PackageType)
Items Value: "pades_container"

List of formats the session should be packaged to when signed

object (Signer)

The intended signer of the Signing Session

object (ArchiveSettings)

Define what objects should be added to archive

object (PreAuthentication)

Set up authentication of signer before presenting documents

language
string (LanguageEnum)
Enum: "EN" "DA" "SV" "FI" "NL" "DE" "NO"

Specifies the language to be used in the signing UI

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a signature session

Returns the signature session with the given ID.

Authorizations:
bearerAuth
path Parameters
sessionId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "f05d0dce-a7af-432b-b6b8-e455ab7c0852",
  • "signatureUrl": "https://signtest-account.sandbox.signicat.com/sign/?sessionId=8ce3dac2-74b3-429c-adf7-fe6d277186d0",
  • "recipient": {
    },
  • "title": "Business Process",
  • "signText": "Please sign this document",
  • "dueDate": "2017-07-21T17:32:28Z",
  • "documents": [
    ],
  • "lifecycle": {
    },
  • "senderDisplayName": "Corporation incorporated",
  • "output": {
    },
  • "externalReference": "string",
  • "userInteractionSetup": [
    ],
  • "subsequentTo": [
    ],
  • "packageTo": [
    ],
  • "signer": {
    },
  • "archive": {
    },
  • "preAuthentication": {
    },
  • "language": "EN"
}

Delete a signature session

Deletes the signature session with the given ID.

Authorizations:
bearerAuth
path Parameters
sessionId
required
string

Responses

Response samples

Content type
application/problem+json
{}