Signicat Secure Share API (v1)

Download OpenAPI specification:Download

Base URL: https://api.signicat.com/secure-share/
Documentation: See the Secure Share developer documentation.
Support: Create a support ticket in the Signicat Dashboard.

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 Title of the share
description	string or null Description of what this share contains
externalReference	string or null Create a reference to your own system, this value is also used for binding billing events
usageReference	string or null
	Array of objects (CreateShareRecipientDto) 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 Keywords you can use for filtering your shares
expires	string or null <date-time> Expire date for this share, after that you and your recipients can't access the share anymore
requestDomain	string or null 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

Payload

Content type

application/json

{"title": "Title of the share",
"description": "Description of what this share contains",
"externalReference": "8a31e934-3e61-4c5e-8f41-693186dd0e06",
"usageReference": "931b2c5a-1ccf-4b6a-a700-f0b774964dfb",
"recipients": [ ],
"contactDetails": {"email": "email@example.com",
"name": "name",
"mobile": null,
"notificationOptions": null
},
"tags": ["custom-tag",
"another-custom-tag"
],
"expires": "2026-07-15T06:27:19.0968183+00:00",
"requestDomain": "my-custom-domain"
}

Response samples

201
400
401
500

Content type

application/json

{"id": "bfaf5a12-afc7-41f4-80bf-c60071b5b5ec",
"title": "Title of the share",
"description": "Description of what this share contains",
"externalReference": "8a31e934-3e61-4c5e-8f41-693186dd0e06",
"usageReference": "931b2c5a-1ccf-4b6a-a700-f0b774964dfb",
"recipients": [ ],
"files": [ ],
"expires": "2026-07-15T06:27:19.0968183+00:00",
"created": "2026-07-08T06:27:19.1014613+00:00",
"contactDetails": {"email": "email@example.com",
"name": "name",
"mobile": null,
"notificationOptions": null
},
"tags": ["custom-tag",
"another-custom-tag"
],
"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-07-01T06:27:19.1119883+00:00 Starting date for share create time
to	string or null <date-time> Example: to=2026-07-08T06:27:19.1120272+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

200
400
401
500

Content type

application/json

{"limit": 50,
"offset": 10,
"count": 1,
"total": 1,
"data": [{"id": "e00f6c2a-2d56-4809-8bb4-89a3f08e6c94",
"title": "Title of the share",
"description": "Description of the share",
"externalReference": "480c2521-5f72-4a57-b763-26906bb02bfb",
"usageReference": "a46edc32-8260-4199-8b4c-9ea7f15ff609",
"recipients": [{"id": "55596d29-c811-4438-b4f8-7ee7c806b893",
"externalReference": "9983cb87-b082-42e3-985e-32356c45a639",
"firstName": "John",
"lastName": "Johnson",
"email": "john.johnson@signicat.com",
"mobile": "0777777777",
"fileAccessInfos": [{"id": "ad729435-0d81-4905-a71e-312e437fd68f",
"lastDownloadedAt": "2026-07-08T06:27:19.1123373+00:00"
}
],
"fileRestrictions": ["ad729435-0d81-4905-a71e-312e437fd68f"
],
"authentication": [{"identityProvider": "otp-sms",
"idpId": null,
"nin": null
},
{"identityProvider": "otp-email",
"idpId": null,
"nin": null
}
],
"loggedInTime": "2026-07-08T06:22:19.1123511+00:00",
"url": null,
"notification": {"sendEmail": true,
"sendSms": true,
"language": "En"
}
}
],
"files": [{"id": "ad729435-0d81-4905-a71e-312e437fd68f",
"name": "File1",
"status": "Success",
"size": 1234,
"message": null
},
{"id": "1b589e4a-0453-4f8c-b2e8-5f8df5f29119",
"name": "File2",
"status": "VirusFound",
"size": 5023412,
"message": "This file contains a malicious script"
},
{"id": "fd09e94c-4c58-4229-86f9-cba8eb393a8d",
"name": "File3",
"status": "Failed",
"size": 5678,
"message": "Something went wrong uploading the file"
},
{"id": "01a14520-d6bc-4676-ad32-b4685ac7befe",
"name": "File4",
"status": "Success",
"size": 69420,
"message": null
}
],
"expires": "2026-07-15T06:27:19.1123563+00:00",
"created": "2026-07-08T06:27:19.1123566+00:00",
"contactDetails": {"email": "email@example.com",
"name": "John Musk",
"mobile": null,
"notificationOptions": null
},
"tags": ["custom-tag"
],
"requestDomain": "my-custom-domain",
"completedRecipients": 0,
"status": "Active",
"providerPath": "secure-share"
}
]
}

Get share

Get a secure share object

path Parameters

shareId

required

string <guid>

Example: 340c6d2c-2f6d-4f11-a8d8-00fd798373b4

Unique Share identifier

Responses

Response samples

200
401
500

Content type

application/json

{"id": "b008e9c8-a476-4008-b6cd-1c6895e53194",
"title": "Title of the share",
"description": "Description of the share",
"externalReference": "71dd130e-b3be-45ba-b01f-cd8820e6ccbb",
"usageReference": "71cda9a3-cdff-4b9d-90fe-e0cc6e5d3c82",
"recipients": [{"id": "abc5c4fe-b20c-4f6f-897e-f1902b1a945c",
"externalReference": "04bc7439-afc3-45df-9762-c1dbef681709",
"firstName": "John",
"lastName": "Johnson",
"email": "john.johnson@signicat.com",
"mobile": "0777777777",
"fileAccessInfos": [{"id": "43dcdee0-a507-4674-9698-0451130a7944",
"lastDownloadedAt": "2026-07-08T06:27:19.1046377+00:00"
}
],
"fileRestrictions": ["43dcdee0-a507-4674-9698-0451130a7944"
],
"authentication": [{"identityProvider": "otp-sms",
"idpId": null,
"nin": null
},
{"identityProvider": "otp-email",
"idpId": null,
"nin": null
}
],
"loggedInTime": "2026-07-08T06:22:19.1089214+00:00",
"url": null,
"notification": {"sendEmail": true,
"sendSms": true,
"language": "En"
}
},
{"id": "f9640805-60fa-4898-8f3a-954f33428352",
"externalReference": "79edbc3f-57ad-4ec5-b0a3-f911727e8ac9",
"firstName": "Mark",
"lastName": "Markus",
"email": "mark.markus@signicat.com",
"mobile": "0771234567",
"fileAccessInfos": [{"id": "43dcdee0-a507-4674-9698-0451130a7944",
"lastDownloadedAt": "2026-07-08T06:27:19.1090873+00:00"
},
{"id": "da11a601-d87e-446d-8a01-65aeb37a96e0",
"lastDownloadedAt": "2026-07-08T06:27:19.1093568+00:00"
}
],
"fileRestrictions": null,
"authentication": [{"identityProvider": "nbid",
"idpId": "1234-5678-7890",
"nin": null
},
{"identityProvider": "mitid",
"idpId": null,
"nin": "12351246127"
}
],
"loggedInTime": "2026-07-08T06:22:19.1093643+00:00",
"url": null,
"notification": {"sendEmail": true,
"sendSms": false,
"language": "En"
}
}
],
"files": [{"id": "43dcdee0-a507-4674-9698-0451130a7944",
"name": "File1",
"status": "Success",
"size": 1234,
"message": null
},
{"id": "3e8eb5a6-e8e2-4d23-a8b6-dc57d81ec744",
"name": "File2",
"status": "VirusFound",
"size": 5023412,
"message": "This file contains a malicious script"
},
{"id": "c64ca86e-c480-4af7-bebe-2cf3fd5fcb07",
"name": "File3",
"status": "Failed",
"size": 5678,
"message": "Something went wrong uploading the file"
},
{"id": "da11a601-d87e-446d-8a01-65aeb37a96e0",
"name": "File4",
"status": "Success",
"size": 69420,
"message": null
}
],
"expires": "2026-07-15T06:27:19.1093733+00:00",
"created": "2026-07-08T06:27:19.1093736+00:00",
"contactDetails": {"email": "email@example.com",
"name": "John Musk",
"mobile": null,
"notificationOptions": null
},
"tags": ["custom-tag"
],
"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: 5a33d022-ac9c-4200-bb44-059a8adde1d5

Unique Share identifier

Responses

Response samples

401
500

Content type

application/json

{"type": null,
"title": null,
"status": null,
"detail": null,
"instance": null
}

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: b33f8217-f64f-4fd7-a4f7-208169c021d9

The identifier of the share this recipient belongs to

Request Body schema: application/json
required

firstName	string or null Recipient first name
lastName	string or null Recipient last name
email	string or null <email> ^[^@]+@[^@]+$ Recipient email. Email is required if mobile is not provided or if it used by authentications or notifications
mobile	string or null 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 > ] 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 List of authentication methods for a recipient
	(NotificationDto (object or null)) Recipient notification setup
externalReference	string or null Create a reference to your own system

Responses

Request samples

Payload

Content type

application/json

{"firstName": "John",
"lastName": "Johnson",
"email": "john.johnson@signicat.com",
"mobile": "+4771234567",
"fileRestrictions": [ ],
"authentication": [{"identityProvider": "nbid",
"idpId": "1234-3456-5678",
"nin": "12345678901"
}
],
"notification": {"sendEmail": true,
"sendSms": true,
"language": "En"
},
"externalReference": "fd673b9e-a37f-4226-909b-ab8b57ef5986"
}

Response samples

201
400
401
500

Content type

application/json

{"id": "ae5f4e02-7354-484d-b502-a28e3bdc77f6",
"externalReference": "84e2cdf5-c77a-4cec-af9c-81d3cea650e2",
"firstName": "John",
"lastName": "Johnson",
"email": "john.johnson@signicat.com",
"mobile": "0777777777",
"fileAccessInfos": [{"id": "69832d88-d631-4fe6-86fd-b50e54bdaeb9",
"lastDownloadedAt": "2026-07-08T06:27:19.115306+00:00"
}
],
"fileRestrictions": ["69832d88-d631-4fe6-86fd-b50e54bdaeb9"
],
"authentication": [{"identityProvider": "otp-sms",
"idpId": null,
"nin": null
},
{"identityProvider": "otp-email",
"idpId": null,
"nin": null
}
],
"loggedInTime": "2026-07-08T06:22:19.1153128+00:00",
"url": null,
"notification": {"sendEmail": true,
"sendSms": true,
"language": "En"
}
}

Delete recipient

Remove a recipient from an existing share

path Parameters

shareId required	string <guid> Example: 717fe74c-16a0-441c-be11-5b1830290b5e Unique Share identifier
recipientId required	string <guid> Example: 35f140b9-e222-4591-975b-dabfe46ae969 Unique Recipient identifier

Responses

Response samples

401
500

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: 554f2979-e45f-4c8a-820e-885d2f3a2895 Unique Share identifier
recipientId required	string <guid> Example: 02f22be4-8f3e-483a-a2a5-75e5178c145c Unique Recipient identifier

Responses

Response samples

200
401
500

Content type

application/json

{"id": "2d340d4a-c71d-43b9-9cdd-b33349695d00",
"externalReference": "b9b208e6-2439-4578-9107-b09a75be1dfe",
"firstName": "John",
"lastName": "Johnson",
"email": "john.johnson@signicat.com",
"mobile": "0777777777",
"fileAccessInfos": [{"id": "8eeba756-2ff2-41c3-bbe2-9f80852c530c",
"lastDownloadedAt": "2026-07-08T06:27:19.1167728+00:00"
}
],
"fileRestrictions": ["8eeba756-2ff2-41c3-bbe2-9f80852c530c"
],
"authentication": [{"identityProvider": "otp-sms",
"idpId": null,
"nin": null
},
{"identityProvider": "otp-email",
"idpId": null,
"nin": null
}
],
"loggedInTime": "2026-07-08T06:22:19.1167783+00:00",
"url": null,
"notification": {"sendEmail": true,
"sendSms": true,
"language": "En"
}
}

Update recipient

Update a recipient from an existing share

path Parameters

shareId required	string <guid> Example: c776d045-7a52-4350-b631-7aff115526da The identifier of the share this recipient belongs to
recipientId required	string <guid> Example: 9a3ebf76-7fe1-4f32-938d-4bfe2af1bc0a Unique recipient identifier

Request Body schema: application/json
required

firstName	string or null Recipient first name
lastName	string or null Recipient last name
email	string or null <email> ^[^@]+@[^@]+$ Recipient email
mobile	string or null Recipient mobile
externalReference	string or null Create a reference to your own system
fileRestrictions	Array of strings or null <guid> [ items <guid > ] 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) List of authentication methods for a recipient
	(UpdateNotificationDto (object or null)) Recipient notification setup

Responses

Request samples

Payload

Content type

application/json

{"firstName": "John",
"lastName": "Johnson",
"email": "john.johnson@signicat.com",
"mobile": "+4771234567",
"externalReference": "dd3324c4-ab55-45fe-8392-15b2b3b6c28a",
"fileRestrictions": [ ],
"authentication": [{"identityProvider": "sbid",
"idpId": "5678-1234-3456",
"nin": "10234567893"
}
],
"notification": {"sendEmail": true,
"sensSms": true,
"language": null
}
}

Response samples

201
400
401
500

Content type

application/json

{"id": "a84ebfab-096d-4014-b6db-e9c236746a75",
"externalReference": "94e25092-9181-494a-9b85-8c337b1523a3",
"firstName": "John",
"lastName": "Johnson",
"email": "john.johnson@signicat.com",
"mobile": "0777777777",
"fileAccessInfos": [ ],
"fileRestrictions": [ ],
"authentication": [{"identityProvider": "sbid",
"idpId": "5678-1234-3456",
"nin": "10234567893"
}
],
"loggedInTime": "2026-07-08T06:22:19.1188658+00:00",
"url": null,
"notification": {"sendEmail": true,
"sendSms": true,
"language": "En"
}
}

Remind recipient

Send a reminder notification to a specific recipient

path Parameters

shareId required	string <guid> Example: ffec3f7c-40ad-4106-b231-6eda3bdea986 Unique Share identifier
recipientId required	string <guid> Example: 1165f6a7-6b4b-47cf-ac91-c5a129268948 Unique Recipient identifier

Responses

Response samples

401
500

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: 338994c3-323b-4bd8-8de8-c49f14417662 Unique Share identifier
fileId required	string <guid> Example: c60e5f04-5e53-4dae-a41d-3f8ed672e4e4 Unique File identifier

Responses

Response samples

401
500

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: 7273057a-3367-4cdc-a881-243a9a271f45

Unique Share identifier

Responses

Response samples

200
401
500

Content type

application/json

[{"id": "650720b7-7888-4e51-b049-50cfc07a371f",
"name": "File1",
"status": "Success",
"size": 1234,
"message": null
},
{"id": "61788ed6-5ce9-469c-ae6e-0bb3013407be",
"name": "File2",
"status": "VirusFound",
"size": 5023412,
"message": "This file contains a malicious script"
},
{"id": "e015d596-f0ac-476b-8673-fdf9161102a2",
"name": "File3",
"status": "Failed",
"size": 5678,
"message": "Something went wrong uploading the file"
},
{"id": "2d8e9ebc-d73c-41a0-8c88-258dbaa53c23",
"name": "File4",
"status": "Success",
"size": 69420,
"message": null
}
]

Signicat Secure Share API (v1)

Introduction

Get started

Audit logs

Errors

Events (callback)

Shares

Create share

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List shares

query Parameters

Responses

Response samples

Get share

path Parameters

Responses

Response samples

Delete share

path Parameters

Responses

Response samples

Update share

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Recipients

Create recipient

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete recipient

path Parameters

Responses

Response samples

Get recipient

path Parameters

Responses

Response samples

Update recipient

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Remind recipient

path Parameters

Responses

Response samples

Files

Delete file

path Parameters

Responses

Response samples

Upload file

path Parameters

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required