Skip to main content
API docs by Redocly

Signicat Secure Share API (v1)

Download OpenAPI specification:Download

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: "75be0c38-8f2f-48be-855f-b82b6ff23468"

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

usageReference
string or null
Example: "4a574f8a-1f5c-46aa-ba1b-adc76d8015b5"
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: "2025-11-17T13:24:59.9227547+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": "75be0c38-8f2f-48be-855f-b82b6ff23468",
  • "usageReference": "4a574f8a-1f5c-46aa-ba1b-adc76d8015b5",
  • "recipients": [ ],
  • "contactDetails": {
    },
  • "tags": [
    ],
  • "expires": "2025-11-17T13:24:59.9227547+00:00",
  • "requestDomain": "my-custom-domain"
}

Response samples

Content type
application/json
{
  • "id": "d5b0d0c2-54b3-4ef3-9da1-e82a5ec4983c",
  • "title": "Title of the share",
  • "description": "Description of what this share contains",
  • "externalReference": "75be0c38-8f2f-48be-855f-b82b6ff23468",
  • "usageReference": "4a574f8a-1f5c-46aa-ba1b-adc76d8015b5",
  • "recipients": [ ],
  • "files": [ ],
  • "expires": "2025-11-17T13:24:59.9227547+00:00",
  • "created": "2025-11-10T13:24:59.9260901+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=2025-11-03T13:24:59.9316349+00:00

Starting date for share create time

to
string or null <date-time>
Example: to=2025-11-10T13:24:59.9316702+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: 14d80e63-b997-4c15-b574-8811c1196236

Unique Share identifier

Responses

Response samples

Content type
application/json
{
  • "id": "e489302d-9b98-4ffc-8965-241a7cb996e0",
  • "title": "Title of the share",
  • "description": "Description of the share",
  • "externalReference": "5d6b3791-a92e-4c0a-88e3-cca5d7646989",
  • "usageReference": "a67191d9-38df-42a1-abbf-4edf78dd0f44",
  • "recipients": [
    ],
  • "files": [
    ],
  • "expires": "2025-11-17T13:24:59.9296605+00:00",
  • "created": "2025-11-10T13:24:59.9296607+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: 30e9f9ad-4200-467c-abdc-5e5393fc4fc1

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: 77753237-b299-418c-8cfb-cd5fcd534b3c
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: "2025-11-10T13:24:59.9326967+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": "2025-11-10T13:24:59.9326967+00:00"
}

Response samples

Content type
application/json
{
  • "id": "4f785d5b-60c5-402b-9af2-1777a1ff15a1",
  • "title": "Title of the share",
  • "description": "Description of what this share contains",
  • "externalReference": "d5e11c30-e7ec-4727-840c-0f65bb99d408",
  • "usageReference": "839002cf-dce3-4ae8-ae11-d0b5e0356ba3",
  • "recipients": [ ],
  • "files": [ ],
  • "expires": "2025-11-10T13:24:59.9326967+00:00",
  • "created": "2025-11-03T13:24:59.9326967+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: 68c6bb41-2194-4af4-9eef-aa05a1681eba

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","emailTemplate":null,"smsTemplate":null}

Recipient notification setup

externalReference
string or null
Example: "24c55009-2ebe-4460-8542-62aa4b794847"

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": "24c55009-2ebe-4460-8542-62aa4b794847"
}

Response samples

Content type
application/json
{
  • "id": "3e91988d-16f4-4789-bb0d-3d471e2fc1a1",
  • "externalReference": "d96da4cc-bfaa-492d-94ba-88bad18e4c67",
  • "firstName": "John",
  • "lastName": "Johnson",
  • "email": "john.johnson@signicat.com",
  • "mobile": "0777777777",
  • "fileAccessInfos": [
    ],
  • "fileRestrictions": [
    ],
  • "authentication": [
    ],
  • "loggedInTime": "2025-11-10T13:19:59.9340753+00:00",
  • "url": null,
  • "notification": {
    }
}

Delete recipient

Remove a recipient from an existing share

path Parameters
shareId
required
string <guid>
Example: c37fa930-0fcc-406f-8e20-20dd13d7fae6

Unique Share identifier

recipientId
required
string <guid>
Example: 43cf8f89-ec26-46f9-9202-97fc1e437b06

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: 87c83cff-50f1-4a66-a42d-dc516605ebd5

Unique Share identifier

recipientId
required
string <guid>
Example: 3dccb0c7-d2f9-4233-b23a-afbd9575c324

Unique Recipient identifier

Responses

Response samples

Content type
application/json
{
  • "id": "4a528936-8646-4bcb-9404-8e80f42126b6",
  • "externalReference": "a73b8da0-c3e8-443a-8842-5e761e254715",
  • "firstName": "John",
  • "lastName": "Johnson",
  • "email": "john.johnson@signicat.com",
  • "mobile": "0777777777",
  • "fileAccessInfos": [
    ],
  • "fileRestrictions": [
    ],
  • "authentication": [
    ],
  • "loggedInTime": "2025-11-10T13:19:59.9352311+00:00",
  • "url": null,
  • "notification": {
    }
}

Update recipient

Update a recipient from an existing share

path Parameters
shareId
required
string <guid>
Example: 7c6949f0-0145-4b1b-aeac-a24d0c7694a6

The identifier of the share this recipient belongs to

recipientId
required
string <guid>
Example: 550845c3-d72c-4acb-829c-4e389c636d20

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: "c37b176f-180a-4b8c-b76a-2950154567e2"

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,"emailTemplate":null,"smsTemplate":null}

Recipient notification setup

Responses

Request samples

Content type
application/json
{
  • "firstName": "John",
  • "lastName": "Johnson",
  • "email": "john.johnson@signicat.com",
  • "mobile": "+4771234567",
  • "externalReference": "c37b176f-180a-4b8c-b76a-2950154567e2",
  • "fileRestrictions": [ ],
  • "authentication": [
    ],
  • "notification": {
    }
}

Response samples

Content type
application/json
{
  • "id": "2c440970-db21-46e0-9d88-968787e3d896",
  • "externalReference": "4283e2e5-aa38-4150-902c-2ae453bfa5b7",
  • "firstName": "John",
  • "lastName": "Johnson",
  • "email": "john.johnson@signicat.com",
  • "mobile": "0777777777",
  • "fileAccessInfos": [ ],
  • "fileRestrictions": [ ],
  • "authentication": [
    ],
  • "loggedInTime": "2025-11-10T13:19:59.9368055+00:00",
  • "url": null,
  • "notification": {
    }
}

Remind recipient

Send a reminder notification to a specific recipient

path Parameters
shareId
required
string <guid>
Example: 1ff6bdc2-81ef-48ff-b56e-b40967187ce4

Unique Share identifier

recipientId
required
string <guid>
Example: 7cc7a3ff-5c84-497a-b5d4-ce2eb5128fc2

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: 19e53025-bd24-4d0e-937d-46bd9a0c2dba

Unique Share identifier

fileId
required
string <guid>
Example: ec1b68c0-b031-48da-aab4-7b3daf8a8f86

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: c8f671aa-e860-4494-a419-e89e7b6c2a90

Unique Share identifier

Responses

Response samples

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