Skip to main content
API docs by Redocly

Signicat Secure Share API (v1)

Download OpenAPI specification:Download

Introduction

The Secure Share API enables you to securely share files with other people in a programmatic way.

You can choose among different levels of security, ranging from weaker methods, such as One-Time Passwords (OTPs), to stronger methods, like using electronic IDs (eIDs).

This REST API uses the OAuth 2.0 protocol for authorisation. All request and response bodies are formatted in JSON.

Get started

Before you can start making requests to this API, you need to learn how to connect to it. To do this, see the Connect to Signicat APIs Quick start guide.

Audit logs

Use the Signicat Audit logs service to see documented evidence of the sequence of activities that have affected a system.

  • Access it: Signicat Dashboard > Settings > Audit logs
  • For information generic to all Signicat audit logs, see the general Audit logs documentation.

Errors

When you make an API call to Signicat and an error occurs, you will receive a response message with an error code.

  • For errors generic to all Signicat APIs, see the general Error codes documentation.

Events (callback)

Use the Signicat Events service to automatically receive information about when something happens in one of our services into your system.

  • Access it: Go to Signicat Dashboard > Settings > Events
  • For information generic to all Signicat events, see the general Events documentation.

Note: This is often referred to as callback.

Shares

Contains requests related to share objects

Create share

Create a secure share to upload files into

Request Body schema: application/json
required
title
string or null
Example: "Title of the share"

Title of the share

description
string or null
Example: "Description of what this share contains"

Description of what this share contains

externalReference
string or null
Example: "12b7497f-d426-4c6b-8fbc-f4876867d055"

Create a reference to your own system, this value is also used for binding billing events

usageReference
string or null
Example: "b69f70fd-a8fd-4ebb-8075-18223c9c9b1c"
Array of objects (CreateShareRecipientDto)
Example: []

A list of recipients for this share, we recommend to add them later after you add the files

required
object (ContactDetailsDto)
tags
Array of strings or null
Example: ["custom-tag","another-custom-tag"]

Keywords you can use for filtering your shares

expires
string or null <date-time>
Example: "2026-05-20T12:06:52.2707919+00:00"

Expire date for this share, after that you and your recipients can't access the share anymore

requestDomain
string or null
Example: "my-custom-domain"

This specifies the domain you want to use for this specific session. The domain will be visible in the end-user's browser. This domain needs to be correctly configured on your account!

Responses

Request samples

Content type
application/json
{
  • "title": "Title of the share",
  • "description": "Description of what this share contains",
  • "externalReference": "12b7497f-d426-4c6b-8fbc-f4876867d055",
  • "usageReference": "b69f70fd-a8fd-4ebb-8075-18223c9c9b1c",
  • "recipients": [ ],
  • "contactDetails": {
    },
  • "tags": [
    ],
  • "expires": "2026-05-20T12:06:52.2707919+00:00",
  • "requestDomain": "my-custom-domain"
}

Response samples

Content type
application/json
{
  • "id": "30f104cb-d458-4bed-918e-e5722675d501",
  • "title": "Title of the share",
  • "description": "Description of what this share contains",
  • "externalReference": "12b7497f-d426-4c6b-8fbc-f4876867d055",
  • "usageReference": "b69f70fd-a8fd-4ebb-8075-18223c9c9b1c",
  • "recipients": [ ],
  • "files": [ ],
  • "expires": "2026-05-20T12:06:52.2707919+00:00",
  • "created": "2026-05-13T12:06:52.2772616+00:00",
  • "contactDetails": {
    },
  • "tags": [
    ],
  • "requestDomain": "my-custom-domain",
  • "completedRecipients": 0,
  • "status": "Active",
  • "providerPath": "secure-share"
}

List shares

List shares created by your account using filters

query Parameters
from
string or null <date-time>
Example: from=2026-05-06T12:06:52.28736+00:00

Starting date for share create time

to
string or null <date-time>
Example: to=2026-05-13T12:06:52.2873924+00:00

Ending date for share create time

offset
integer or null <int32>
Example: offset=10

The number of share to skip

limit
integer or null <int32>
Example: limit=50

The maximum number of fetched shares

sort
string or null

Supported fields: title, created, expires

search
string or null
Example: search=important

Keywords to search for in the share title

Responses

Response samples

Content type
application/json
{
  • "limit": 50,
  • "offset": 10,
  • "count": 1,
  • "total": 1,
  • "data": [
    ]
}

Get share

Get a secure share object

path Parameters
shareId
required
string <guid>
Example: 04c2f1e1-8fcb-4e46-96f7-f5438c94c7ee

Unique Share identifier

Responses

Response samples

Content type
application/json
{
  • "id": "dbad7995-5528-472f-8766-7028f0c54dc7",
  • "title": "Title of the share",
  • "description": "Description of the share",
  • "externalReference": "d6a7cfd1-70d7-487b-8fa2-3276b5e15914",
  • "usageReference": "7360b57f-71b5-4b41-9a31-b8a366f8d009",
  • "recipients": [
    ],
  • "files": [
    ],
  • "expires": "2026-05-20T12:06:52.28533+00:00",
  • "created": "2026-05-13T12:06:52.2853302+00:00",
  • "contactDetails": {
    },
  • "tags": [
    ],
  • "requestDomain": "my-custom-domain",
  • "completedRecipients": 0,
  • "status": "Active",
  • "providerPath": "secure-share"
}

Delete share

Remove a secure share with all the data in it (recipients/files)

path Parameters
shareId
required
string <guid>
Example: ac52a051-2a80-42d0-a3e3-72f317ee6582

Unique Share identifier

Responses

Response samples

Content type
application/json
{
  • "type": null,
  • "title": null,
  • "status": null,
  • "detail": null,
  • "instance": null
}

Update share

Update an existing share object

path Parameters
shareId
required
string <guid>
Example: 4008dda3-facc-4ebd-a70c-935b36aa597a
Request Body schema: application/json
required
title
string or null
Example: "Title of the share"

Title of the share

description
string or null
Example: "Description of what this share contains"

Description of what this share contains

(UpdateContactDetailsDto (object or null))
Example: {"email":"email@example.com","name":"name","mobile":null,"notificationOptions":null}
expires
string or null <date-time>
Example: "2026-05-13T12:06:52.2886378+00:00"

Expire date for this share, after that you and your recipients can't access the share anymore

Responses

Request samples

Content type
application/json
{
  • "title": "Title of the share",
  • "description": "Description of what this share contains",
  • "contactDetails": {
    },
  • "expires": "2026-05-13T12:06:52.2886378+00:00"
}

Response samples

Content type
application/json
{
  • "id": "9db29ccc-4cdd-41c4-bd5e-89d91406e63c",
  • "title": "Title of the share",
  • "description": "Description of what this share contains",
  • "externalReference": "92519ed7-a543-47ee-8c15-f58a49cbd6e7",
  • "usageReference": "17abb224-c35b-4e47-98cf-97d3b00f3f34",
  • "recipients": [ ],
  • "files": [ ],
  • "expires": "2026-05-13T12:06:52.2886378+00:00",
  • "created": "2026-05-06T12:06:52.2886378+00:00",
  • "contactDetails": {
    },
  • "tags": [ ],
  • "requestDomain": null,
  • "completedRecipients": 0,
  • "status": "Active",
  • "providerPath": "secure-share"
}

Recipients

Contains requests related to recipients

Create recipient

Create a recipient and add it to an existing share

path Parameters
shareId
required
string <guid>
Example: 69d2ee25-97b0-4fee-aa10-56a25872efee

The identifier of the share this recipient belongs to

Request Body schema: application/json
required
firstName
string or null
Example: "John"

Recipient first name

lastName
string or null
Example: "Johnson"

Recipient last name

email
string or null <email> ^[^@]+@[^@]+$
Example: "john.johnson@signicat.com"

Recipient email. Email is required if mobile is not provided or if it used by authentications or notifications

mobile
string or null
Example: "+4771234567"

Recipient mobile. Mobile is required if email is not provided or if it used by authentications or notifications

fileRestrictions
Array of strings or null <guid> [ items <guid > ]
Example: []

A list of file ids that this recipient has access to, if empty, this recipient will have access to all the file from the share

required
Array of objects (AuthenticationDto) non-empty
Example: [{"identityProvider":"nbid","idpId":"1234-3456-5678","nin":"12345678901"}]

List of authentication methods for a recipient

(NotificationDto (object or null))
Example: {"sendEmail":true,"sendSms":true,"language":"En"}

Recipient notification setup

externalReference
string or null
Example: "5f578586-7c35-4afc-a5ca-bd67205c5f93"

Create a reference to your own system

Responses

Request samples

Content type
application/json
{
  • "firstName": "John",
  • "lastName": "Johnson",
  • "email": "john.johnson@signicat.com",
  • "mobile": "+4771234567",
  • "fileRestrictions": [ ],
  • "authentication": [
    ],
  • "notification": {
    },
  • "externalReference": "5f578586-7c35-4afc-a5ca-bd67205c5f93"
}

Response samples

Content type
application/json
{
  • "id": "8bafd853-6ecd-48a5-a6dc-90added675e7",
  • "externalReference": "5432ec31-1ba6-4a4a-a572-aca495e42d3c",
  • "firstName": "John",
  • "lastName": "Johnson",
  • "email": "john.johnson@signicat.com",
  • "mobile": "0777777777",
  • "fileAccessInfos": [
    ],
  • "fileRestrictions": [
    ],
  • "authentication": [
    ],
  • "loggedInTime": "2026-05-13T12:01:52.2902248+00:00",
  • "url": null,
  • "notification": {
    }
}

Delete recipient

Remove a recipient from an existing share

path Parameters
shareId
required
string <guid>
Example: c9de8f70-a131-4116-ae3d-6f3af0f58e45

Unique Share identifier

recipientId
required
string <guid>
Example: a8252a8c-956f-4a88-8a76-5aba5d161f7b

Unique Recipient identifier

Responses

Response samples

Content type
application/json
{
  • "type": null,
  • "title": null,
  • "status": null,
  • "detail": null,
  • "instance": null
}

Get recipient

Get a recipient from an existing share

path Parameters
shareId
required
string <guid>
Example: 652bd7bb-6d74-44c0-a8cb-e9eed512df32

Unique Share identifier

recipientId
required
string <guid>
Example: 0dd9a37a-0339-42ff-a7f5-b165692749a6

Unique Recipient identifier

Responses

Response samples

Content type
application/json
{
  • "id": "af492316-75ef-48e6-9437-7f773c607701",
  • "externalReference": "1956d588-f1f5-46e4-8ef8-c5f6c23a1b15",
  • "firstName": "John",
  • "lastName": "Johnson",
  • "email": "john.johnson@signicat.com",
  • "mobile": "0777777777",
  • "fileAccessInfos": [
    ],
  • "fileRestrictions": [
    ],
  • "authentication": [
    ],
  • "loggedInTime": "2026-05-13T12:01:52.2918386+00:00",
  • "url": null,
  • "notification": {
    }
}

Update recipient

Update a recipient from an existing share

path Parameters
shareId
required
string <guid>
Example: a4b7e815-dfac-49cc-bacb-5705e733fc13

The identifier of the share this recipient belongs to

recipientId
required
string <guid>
Example: 7e8aad81-babe-4e33-9113-4ea04cb0b3f7

Unique recipient identifier

Request Body schema: application/json
required
firstName
string or null
Example: "John"

Recipient first name

lastName
string or null
Example: "Johnson"

Recipient last name

email
string or null <email> ^[^@]+@[^@]+$
Example: "john.johnson@signicat.com"

Recipient email

mobile
string or null
Example: "+4771234567"

Recipient mobile

externalReference
string or null
Example: "691add78-a84f-41f1-b742-2292ed9d906c"

Create a reference to your own system

fileRestrictions
Array of strings or null <guid> [ items <guid > ]
Example: []

A list of file ids that this recipient has access to, if empty, this recipient will have access to all the file from the share

Array of objects or null (AuthenticationDto)
Example: [{"identityProvider":"sbid","idpId":"5678-1234-3456","nin":"10234567893"}]

List of authentication methods for a recipient

(UpdateNotificationDto (object or null))
Example: {"sendEmail":true,"sensSms":true,"language":null}

Recipient notification setup

Responses

Request samples

Content type
application/json
{
  • "firstName": "John",
  • "lastName": "Johnson",
  • "email": "john.johnson@signicat.com",
  • "mobile": "+4771234567",
  • "externalReference": "691add78-a84f-41f1-b742-2292ed9d906c",
  • "fileRestrictions": [ ],
  • "authentication": [
    ],
  • "notification": {
    }
}

Response samples

Content type
application/json
{
  • "id": "4191e70c-1571-4fe5-94df-16062d1239ff",
  • "externalReference": "38837861-686c-4104-a48f-ffb75cf99398",
  • "firstName": "John",
  • "lastName": "Johnson",
  • "email": "john.johnson@signicat.com",
  • "mobile": "0777777777",
  • "fileAccessInfos": [ ],
  • "fileRestrictions": [ ],
  • "authentication": [
    ],
  • "loggedInTime": "2026-05-13T12:01:52.2937604+00:00",
  • "url": null,
  • "notification": {
    }
}

Remind recipient

Send a reminder notification to a specific recipient

path Parameters
shareId
required
string <guid>
Example: 1517cac3-51e6-4e32-a520-cf6f7dec8262

Unique Share identifier

recipientId
required
string <guid>
Example: 22928dad-ac05-4d8f-a9b3-ebab8c56fe88

Unique Recipient identifier

Responses

Response samples

Content type
application/json
{
  • "type": null,
  • "title": null,
  • "status": null,
  • "detail": null,
  • "instance": null
}

Files

Contains requests related to files

Delete file

Remove a file from the storage

path Parameters
shareId
required
string <guid>
Example: 21bd03cd-2a56-4ffb-a702-378b902f8129

Unique Share identifier

fileId
required
string <guid>
Example: 0aa47bcb-e525-4363-acca-19ee75c97e5b

Unique File identifier

Responses

Response samples

Content type
application/json
{
  • "type": null,
  • "title": null,
  • "status": null,
  • "detail": null,
  • "instance": null
}

Upload file

Upload a file(s) using multipart/form-data request body

path Parameters
shareId
required
string <guid>
Example: 2576df5d-cc63-4b07-80af-4da7efcb7b77

Unique Share identifier

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]