{
"openapi": "3.0.1",
"info": {
"title": "Signicat Signature API",
"description": "\n- **Base URL**: `https://api.signicat.com/express/sign/`\n- **Documentation**: See the [Express Signature API](https://developer.signicat.com/cs/express/docs/signature/guides/quick-start/) developer documentation.\n- **Support**: [Create a support ticket](https://dashboard.signicat.com/contact-us/tickets/) in the Signicat Dashboard.\n\n# Introduction\n\nThe Signicat Express Signature API enables you to sign contracts, declarations, forms and other documents using digital signatures.\n\nThis REST API uses the OAuth 2.0 protocol for authorisation. All request and response bodies are formatted in JSON.\n\n# Get started\n\nBefore 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](/docs/connect-to-signicat-apis/quick-start-guide/).\n\n## Audit logs\n\nUse the Signicat **Audit logs** service to see documented evidence of the sequence of activities that have affected a system.\n\n- Access it: **Signicat Dashboard** > **Settings** > [**Audit logs**](https://dashboard.signicat.com/audit)\n- For information generic to all Signicat audit logs, see the general [Audit logs](/docs/audit-logs/) documentation.\n\n## Errors\n\nWhen you make an API call to Signicat and an error occurs, you will receive a response message with an error code.\n\n- For errors generic to all Signicat APIs, see the general [Error codes](/docs/error-codes/) documentation.\n\n## Events (callback)\n\nUse the Signicat **Events** service to automatically receive information about when something happens in one of our services into your system.\n\n- Access it: Go to **Signicat Dashboard** > **Settings** > [**Events**](https://dashboard.signicat.com/events)\n- For information generic to all Signicat events, see the general [Events](/docs/events/) documentation.\n\n> **Note**: This is often referred to as callback.\n",
"version": "v1",
"contact": "",
"license": "",
"termsOfService": ""
},
"servers": [
{
"url": "https://api.signicat.com/express/sign"
}
],
"paths": {
"/documents/{documentId}/attachments": {
"post": {
"tags": [
"Attachments"
],
"summary": "Create attachment",
"description": "Adds an attachments to the specified document. You can choose between different ways to make the user accept the attachment.\r\n The attachment will be deleted together with the main document when the signature job is completed or has expired",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/AttachmentRequest"
},
"example": {
"fileName": "Attachment1.pdf",
"title": "Attachment 1 - Type description",
"data": "Base 64 encoded pdf",
"convertToPdf": false,
"description": "This attachment describes bla bla bla...",
"type": "show_accept"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachmentRequest"
},
"example": {
"fileName": "Attachment1.pdf",
"title": "Attachment 1 - Type description",
"data": "Base 64 encoded pdf",
"convertToPdf": false,
"description": "This attachment describes bla bla bla...",
"type": "show_accept"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AttachmentRequest"
},
"example": {
"fileName": "Attachment1.pdf",
"title": "Attachment 1 - Type description",
"data": "Base 64 encoded pdf",
"convertToPdf": false,
"description": "This attachment describes bla bla bla...",
"type": "show_accept"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AttachmentRequest"
},
"example": {
"fileName": "Attachment1.pdf",
"title": "Attachment 1 - Type description",
"data": "Base 64 encoded pdf",
"convertToPdf": false,
"description": "This attachment describes bla bla bla...",
"type": "show_accept"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachmentResponse"
},
"example": {
"id": "5d5b5c8e-6b1b-447c-a764-08668dc5f815",
"fileName": "Attachment1.pdf",
"title": "Attachment 1 - Type description",
"convertToPdf": false,
"description": "This attachment describes bla bla bla...",
"type": "show_accept"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AttachmentResponse"
},
"example": {
"id": "5d5b5c8e-6b1b-447c-a764-08668dc5f815",
"fileName": "Attachment1.pdf",
"title": "Attachment 1 - Type description",
"convertToPdf": false,
"description": "This attachment describes bla bla bla...",
"type": "show_accept"
}
}
}
},
"201": {
"description": ""
}
}
},
"get": {
"tags": [
"Attachments"
],
"summary": "List attachments",
"description": "Returns a list of all attachments for the specified document.",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttachmentListItem"
}
},
"example": [
{
"id": "9d4c0fe0-fe77-4b3f-8794-33c8ad7c66a5",
"title": "Attachment 1 - Type description",
"description": "This attachment describes bla bla bla...",
"type": "show_accept",
"fileName": "Attachment1.pdf"
},
{
"id": "a9ce2cc0-88bd-477f-a792-7d009b2847a1",
"title": "Attachment 2 - Building sketches",
"description": "This attachment includes sketches of the build at...",
"type": "show_accept",
"fileName": "Attachment2.pdf"
}
]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttachmentListItem"
}
},
"example": [
{
"id": "9d4c0fe0-fe77-4b3f-8794-33c8ad7c66a5",
"title": "Attachment 1 - Type description",
"description": "This attachment describes bla bla bla...",
"type": "show_accept",
"fileName": "Attachment1.pdf"
},
{
"id": "a9ce2cc0-88bd-477f-a792-7d009b2847a1",
"title": "Attachment 2 - Building sketches",
"description": "This attachment includes sketches of the build at...",
"type": "show_accept",
"fileName": "Attachment2.pdf"
}
]
}
}
}
}
}
},
"/documents/{documentId}/attachments/{attachmentId}": {
"get": {
"tags": [
"Attachments"
],
"summary": "Retrieve attachment",
"description": "Retrieves the details of a single attachment.",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "attachmentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachmentResponse"
},
"example": {
"id": "0d18903b-4cab-49b4-9f19-b0cce26bc04c",
"fileName": "Attachment1.pdf",
"title": "Attachment 1 - Type description",
"convertToPdf": false,
"description": "This attachment describes bla bla bla...",
"type": "show_accept"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AttachmentResponse"
},
"example": {
"id": "0d18903b-4cab-49b4-9f19-b0cce26bc04c",
"fileName": "Attachment1.pdf",
"title": "Attachment 1 - Type description",
"convertToPdf": false,
"description": "This attachment describes bla bla bla...",
"type": "show_accept"
}
}
}
}
}
},
"patch": {
"tags": [
"Attachments"
],
"summary": "Update attachment",
"description": "Updates the specified attachment (Will only take affect if no one has signed the document yet)",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "attachmentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateAttachmentRequest"
},
"example": {
"type": "show_accept",
"fileName": "Attachment1.pdf",
"title": "Attachment 1 - Type description",
"data": "Base 64 encoded pdf",
"convertToPdf": false,
"description": "This attachment describes bla bla bla..."
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAttachmentRequest"
},
"example": {
"type": "show_accept",
"fileName": "Attachment1.pdf",
"title": "Attachment 1 - Type description",
"data": "Base 64 encoded pdf",
"convertToPdf": false,
"description": "This attachment describes bla bla bla..."
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAttachmentRequest"
},
"example": {
"type": "show_accept",
"fileName": "Attachment1.pdf",
"title": "Attachment 1 - Type description",
"data": "Base 64 encoded pdf",
"convertToPdf": false,
"description": "This attachment describes bla bla bla..."
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateAttachmentRequest"
},
"example": {
"type": "show_accept",
"fileName": "Attachment1.pdf",
"title": "Attachment 1 - Type description",
"data": "Base 64 encoded pdf",
"convertToPdf": false,
"description": "This attachment describes bla bla bla..."
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachmentResponse"
},
"example": {
"id": "421038a4-c504-46d4-b4cc-1b95824b5043",
"fileName": "Attachment1.pdf",
"title": "Attachment 1 - Type description",
"convertToPdf": false,
"description": "This attachment describes bla bla bla...",
"type": "show_accept"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AttachmentResponse"
},
"example": {
"id": "421038a4-c504-46d4-b4cc-1b95824b5043",
"fileName": "Attachment1.pdf",
"title": "Attachment 1 - Type description",
"convertToPdf": false,
"description": "This attachment describes bla bla bla...",
"type": "show_accept"
}
}
}
}
}
},
"delete": {
"tags": [
"Attachments"
],
"summary": "Delete attachment",
"description": "Deletes the specified attachment (Will only take affect if no one has signed the document yet)",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "attachmentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/documents": {
"post": {
"tags": [
"Documents"
],
"summary": "Create document",
"description": "Creates a new document. In the response you will receive a document ID to retrieve info about the document at a later time. \r\nYou also receive a URL and unique identifier per signer.",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreateDocumentRequest"
},
"example": {
"title": "Test document",
"signers": [
{
"externalSignerId": "uoiahsd321982983jhrmnec2wsadm32",
"redirectSettings": {
"redirectMode": "donot_redirect"
},
"signatureType": {
"mechanism": "pkisignature"
},
"ui": {
"language": "EN",
"dialogs": {
"before": {
"useCheckBox": false,
"title": "Info",
"message": "Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."
}
},
"styling": {
"colorTheme": "Pink",
"spinner": "Cubes",
"hideTopBar": false
}
},
"order": 0,
"required": false,
"getSocialSecurityNumber": false
}
],
"dataToSign": {
"title": "Document title",
"description": "Document description",
"base64Content": "VGhpcyB0ZXh0IGNhbiBzYWZlbHkgYmUgc2lnbmVk",
"fileName": "sample.txt",
"convertToPDF": false
},
"contactDetails": {
"email": "test@test.com",
"url": "https://signicat.io"
},
"externalId": "ae7b9ca7-3839-4e0d-a070-9f14bffbbf55",
"description": "This is an important document",
"advanced": {
"tags": [
"develop",
"fun_with_documents"
],
"attachments": 0,
"requiredSignatures": 0,
"getSocialSecurityNumber": false,
"timeToLive": {
"deadline": "2026-05-30T10:53:18Z",
"deleteAfterHours": 1
}
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDocumentRequest"
},
"example": {
"title": "Test document",
"signers": [
{
"externalSignerId": "uoiahsd321982983jhrmnec2wsadm32",
"redirectSettings": {
"redirectMode": "donot_redirect"
},
"signatureType": {
"mechanism": "pkisignature"
},
"ui": {
"language": "EN",
"dialogs": {
"before": {
"useCheckBox": false,
"title": "Info",
"message": "Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."
}
},
"styling": {
"colorTheme": "Pink",
"spinner": "Cubes",
"hideTopBar": false
}
},
"order": 0,
"required": false,
"getSocialSecurityNumber": false
}
],
"dataToSign": {
"title": "Document title",
"description": "Document description",
"base64Content": "VGhpcyB0ZXh0IGNhbiBzYWZlbHkgYmUgc2lnbmVk",
"fileName": "sample.txt",
"convertToPDF": false
},
"contactDetails": {
"email": "test@test.com",
"url": "https://signicat.io"
},
"externalId": "ae7b9ca7-3839-4e0d-a070-9f14bffbbf55",
"description": "This is an important document",
"advanced": {
"tags": [
"develop",
"fun_with_documents"
],
"attachments": 0,
"requiredSignatures": 0,
"getSocialSecurityNumber": false,
"timeToLive": {
"deadline": "2026-05-30T10:53:18Z",
"deleteAfterHours": 1
}
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateDocumentRequest"
},
"example": {
"title": "Test document",
"signers": [
{
"externalSignerId": "uoiahsd321982983jhrmnec2wsadm32",
"redirectSettings": {
"redirectMode": "donot_redirect"
},
"signatureType": {
"mechanism": "pkisignature"
},
"ui": {
"language": "EN",
"dialogs": {
"before": {
"useCheckBox": false,
"title": "Info",
"message": "Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."
}
},
"styling": {
"colorTheme": "Pink",
"spinner": "Cubes",
"hideTopBar": false
}
},
"order": 0,
"required": false,
"getSocialSecurityNumber": false
}
],
"dataToSign": {
"title": "Document title",
"description": "Document description",
"base64Content": "VGhpcyB0ZXh0IGNhbiBzYWZlbHkgYmUgc2lnbmVk",
"fileName": "sample.txt",
"convertToPDF": false
},
"contactDetails": {
"email": "test@test.com",
"url": "https://signicat.io"
},
"externalId": "ae7b9ca7-3839-4e0d-a070-9f14bffbbf55",
"description": "This is an important document",
"advanced": {
"tags": [
"develop",
"fun_with_documents"
],
"attachments": 0,
"requiredSignatures": 0,
"getSocialSecurityNumber": false,
"timeToLive": {
"deadline": "2026-05-30T10:53:18Z",
"deleteAfterHours": 1
}
}
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateDocumentRequest"
},
"example": {
"title": "Test document",
"signers": [
{
"externalSignerId": "uoiahsd321982983jhrmnec2wsadm32",
"redirectSettings": {
"redirectMode": "donot_redirect"
},
"signatureType": {
"mechanism": "pkisignature"
},
"ui": {
"language": "EN",
"dialogs": {
"before": {
"useCheckBox": false,
"title": "Info",
"message": "Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."
}
},
"styling": {
"colorTheme": "Pink",
"spinner": "Cubes",
"hideTopBar": false
}
},
"order": 0,
"required": false,
"getSocialSecurityNumber": false
}
],
"dataToSign": {
"title": "Document title",
"description": "Document description",
"base64Content": "VGhpcyB0ZXh0IGNhbiBzYWZlbHkgYmUgc2lnbmVk",
"fileName": "sample.txt",
"convertToPDF": false
},
"contactDetails": {
"email": "test@test.com",
"url": "https://signicat.io"
},
"externalId": "ae7b9ca7-3839-4e0d-a070-9f14bffbbf55",
"description": "This is an important document",
"advanced": {
"tags": [
"develop",
"fun_with_documents"
],
"attachments": 0,
"requiredSignatures": 0,
"getSocialSecurityNumber": false,
"timeToLive": {
"deadline": "2026-05-30T10:53:18Z",
"deleteAfterHours": 1
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDocumentResponse"
},
"example": {
"documentId": "94865b6f-2aa9-436d-8b3c-a85e00efd034",
"signers": [
{
"id": "c13d541f-8124-4095-9add-2191c1028f48",
"ui": {
"dialogs": {
"before": {
"useCheckBox": false,
"title": "Info",
"message": "Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."
}
},
"language": "EN",
"styling": {
"colorTheme": "Pink",
"spinner": "Cubes",
"hideTopBar": false
}
},
"externalSignerId": "uoiahsd321982983jhrmnec2wsadm32",
"redirectSettings": {
"redirectMode": "donot_redirect"
},
"signatureType": {
"mechanism": "pkisignature"
},
"order": 0,
"required": false,
"getSocialSecurityNumber": false
}
],
"title": "Test document",
"description": "This is an important document",
"externalId": "ae7b9ca7-3839-4e0d-a070-9f14bffbbf55",
"dataToSign": {
"title": "Document title",
"description": "Document description",
"fileName": "sample.txt",
"convertToPDF": false
},
"contactDetails": {
"email": "test@test.com",
"url": "https://signicat.io"
},
"advanced": {
"tags": [
"develop",
"fun_with_documents"
],
"attachments": 0,
"requiredSignatures": 0,
"getSocialSecurityNumber": false,
"timeToLive": {
"deadline": "2026-05-30T10:53:18Z",
"deleteAfterHours": 1
}
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateDocumentResponse"
},
"example": {
"documentId": "94865b6f-2aa9-436d-8b3c-a85e00efd034",
"signers": [
{
"id": "c13d541f-8124-4095-9add-2191c1028f48",
"ui": {
"dialogs": {
"before": {
"useCheckBox": false,
"title": "Info",
"message": "Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."
}
},
"language": "EN",
"styling": {
"colorTheme": "Pink",
"spinner": "Cubes",
"hideTopBar": false
}
},
"externalSignerId": "uoiahsd321982983jhrmnec2wsadm32",
"redirectSettings": {
"redirectMode": "donot_redirect"
},
"signatureType": {
"mechanism": "pkisignature"
},
"order": 0,
"required": false,
"getSocialSecurityNumber": false
}
],
"title": "Test document",
"description": "This is an important document",
"externalId": "ae7b9ca7-3839-4e0d-a070-9f14bffbbf55",
"dataToSign": {
"title": "Document title",
"description": "Document description",
"fileName": "sample.txt",
"convertToPDF": false
},
"contactDetails": {
"email": "test@test.com",
"url": "https://signicat.io"
},
"advanced": {
"tags": [
"develop",
"fun_with_documents"
],
"attachments": 0,
"requiredSignatures": 0,
"getSocialSecurityNumber": false,
"timeToLive": {
"deadline": "2026-05-30T10:53:18Z",
"deleteAfterHours": 1
}
}
}
}
}
}
}
}
},
"/documents/{documentId}": {
"get": {
"tags": [
"Documents"
],
"summary": "Retrieve document",
"description": "Retrieves details of a single document.",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDocumentResponse"
},
"example": {
"documentId": "94865b6f-2aa9-436d-8b3c-a85e00efd034",
"signers": [
{
"id": "59295f4e-725d-4648-9989-44915f16f5cb",
"ui": {
"dialogs": {
"before": {
"useCheckBox": false,
"title": "Info",
"message": "Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."
}
},
"language": "EN",
"styling": {
"colorTheme": "Pink",
"spinner": "Cubes",
"hideTopBar": false
}
},
"externalSignerId": "uoiahsd321982983jhrmnec2wsadm32",
"redirectSettings": {
"redirectMode": "donot_redirect"
},
"signatureType": {
"mechanism": "pkisignature"
},
"order": 0,
"required": false,
"getSocialSecurityNumber": false
}
],
"title": "Test document",
"description": "This is an important document",
"externalId": "ae7b9ca7-3839-4e0d-a070-9f14bffbbf55",
"dataToSign": {
"title": "Document title",
"description": "Document description",
"fileName": "sample.txt",
"convertToPDF": false
},
"contactDetails": {
"email": "test@test.com",
"url": "https://signicat.io"
},
"advanced": {
"tags": [
"develop",
"fun_with_documents"
],
"attachments": 0,
"requiredSignatures": 0,
"getSocialSecurityNumber": false,
"timeToLive": {
"deadline": "2026-05-30T10:53:18Z",
"deleteAfterHours": 1
}
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateDocumentResponse"
},
"example": {
"documentId": "94865b6f-2aa9-436d-8b3c-a85e00efd034",
"signers": [
{
"id": "59295f4e-725d-4648-9989-44915f16f5cb",
"ui": {
"dialogs": {
"before": {
"useCheckBox": false,
"title": "Info",
"message": "Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."
}
},
"language": "EN",
"styling": {
"colorTheme": "Pink",
"spinner": "Cubes",
"hideTopBar": false
}
},
"externalSignerId": "uoiahsd321982983jhrmnec2wsadm32",
"redirectSettings": {
"redirectMode": "donot_redirect"
},
"signatureType": {
"mechanism": "pkisignature"
},
"order": 0,
"required": false,
"getSocialSecurityNumber": false
}
],
"title": "Test document",
"description": "This is an important document",
"externalId": "ae7b9ca7-3839-4e0d-a070-9f14bffbbf55",
"dataToSign": {
"title": "Document title",
"description": "Document description",
"fileName": "sample.txt",
"convertToPDF": false
},
"contactDetails": {
"email": "test@test.com",
"url": "https://signicat.io"
},
"advanced": {
"tags": [
"develop",
"fun_with_documents"
],
"attachments": 0,
"requiredSignatures": 0,
"getSocialSecurityNumber": false,
"timeToLive": {
"deadline": "2026-05-30T10:53:18Z",
"deleteAfterHours": 1
}
}
}
}
}
}
}
},
"patch": {
"tags": [
"Documents"
],
"summary": "Update document",
"description": "Include the properties/fields you want to update in your request",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateDocumentRequest"
},
"example": {
"title": "Updated title",
"description": "This is an updated description",
"contactDetails": {
"email": "test@test.com",
"url": "https://signicat.io"
},
"advanced": {
"tags": [
"develop",
"fun_with_documents"
],
"attachments": 0,
"requiredSignatures": 0,
"getSocialSecurityNumber": false,
"timeToLive": {
"deadline": "2026-05-30T10:53:18Z",
"deleteAfterHours": 1
}
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDocumentRequest"
},
"example": {
"title": "Updated title",
"description": "This is an updated description",
"contactDetails": {
"email": "test@test.com",
"url": "https://signicat.io"
},
"advanced": {
"tags": [
"develop",
"fun_with_documents"
],
"attachments": 0,
"requiredSignatures": 0,
"getSocialSecurityNumber": false,
"timeToLive": {
"deadline": "2026-05-30T10:53:18Z",
"deleteAfterHours": 1
}
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDocumentRequest"
},
"example": {
"title": "Updated title",
"description": "This is an updated description",
"contactDetails": {
"email": "test@test.com",
"url": "https://signicat.io"
},
"advanced": {
"tags": [
"develop",
"fun_with_documents"
],
"attachments": 0,
"requiredSignatures": 0,
"getSocialSecurityNumber": false,
"timeToLive": {
"deadline": "2026-05-30T10:53:18Z",
"deleteAfterHours": 1
}
}
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateDocumentRequest"
},
"example": {
"title": "Updated title",
"description": "This is an updated description",
"contactDetails": {
"email": "test@test.com",
"url": "https://signicat.io"
},
"advanced": {
"tags": [
"develop",
"fun_with_documents"
],
"attachments": 0,
"requiredSignatures": 0,
"getSocialSecurityNumber": false,
"timeToLive": {
"deadline": "2026-05-30T10:53:18Z",
"deleteAfterHours": 1
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDocumentResponse"
},
"example": {
"documentId": "94865b6f-2aa9-436d-8b3c-a85e00efd034",
"signers": [
{
"id": "045fad6f-3cf9-41eb-b07f-3a7beabc9c1e",
"ui": {
"dialogs": {
"before": {
"useCheckBox": false,
"title": "Info",
"message": "Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."
}
},
"language": "EN",
"styling": {
"colorTheme": "Pink",
"spinner": "Cubes",
"hideTopBar": false
}
},
"externalSignerId": "uoiahsd321982983jhrmnec2wsadm32",
"redirectSettings": {
"redirectMode": "donot_redirect"
},
"signatureType": {
"mechanism": "pkisignature"
},
"order": 0,
"required": false,
"getSocialSecurityNumber": false
}
],
"title": "Updated title",
"description": "This is an updated description",
"externalId": "ae7b9ca7-3839-4e0d-a070-9f14bffbbf55",
"dataToSign": {
"title": "Document title",
"description": "Document description",
"fileName": "sample.txt",
"convertToPDF": false
},
"contactDetails": {
"email": "test@test.com",
"url": "https://signicat.io"
},
"advanced": {
"tags": [
"develop",
"fun_with_documents"
],
"attachments": 0,
"requiredSignatures": 0,
"getSocialSecurityNumber": false,
"timeToLive": {
"deadline": "2026-05-30T10:53:18Z",
"deleteAfterHours": 1
}
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateDocumentResponse"
},
"example": {
"documentId": "94865b6f-2aa9-436d-8b3c-a85e00efd034",
"signers": [
{
"id": "045fad6f-3cf9-41eb-b07f-3a7beabc9c1e",
"ui": {
"dialogs": {
"before": {
"useCheckBox": false,
"title": "Info",
"message": "Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."
}
},
"language": "EN",
"styling": {
"colorTheme": "Pink",
"spinner": "Cubes",
"hideTopBar": false
}
},
"externalSignerId": "uoiahsd321982983jhrmnec2wsadm32",
"redirectSettings": {
"redirectMode": "donot_redirect"
},
"signatureType": {
"mechanism": "pkisignature"
},
"order": 0,
"required": false,
"getSocialSecurityNumber": false
}
],
"title": "Updated title",
"description": "This is an updated description",
"externalId": "ae7b9ca7-3839-4e0d-a070-9f14bffbbf55",
"dataToSign": {
"title": "Document title",
"description": "Document description",
"fileName": "sample.txt",
"convertToPDF": false
},
"contactDetails": {
"email": "test@test.com",
"url": "https://signicat.io"
},
"advanced": {
"tags": [
"develop",
"fun_with_documents"
],
"attachments": 0,
"requiredSignatures": 0,
"getSocialSecurityNumber": false,
"timeToLive": {
"deadline": "2026-05-30T10:53:18Z",
"deleteAfterHours": 1
}
}
}
}
}
}
}
}
},
"/documents/{documentId}/cancel": {
"post": {
"tags": [
"Documents"
],
"summary": "Cancel document",
"description": "Cancel a document, after a document is canceled it cannot be signed. The signer will be presented the reason if they click the sign-url",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "reason",
"in": "query",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/documents/{documentId}/status": {
"get": {
"tags": [
"Documents"
],
"summary": "Retrieve document status",
"description": "Get the status of a document",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Status"
},
"example": {
"documentStatus": "signed",
"completedPackages": [
"standard_packaging",
"pades"
],
"attachmentPackages": {}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Status"
},
"example": {
"documentStatus": "signed",
"completedPackages": [
"standard_packaging",
"pades"
],
"attachmentPackages": {}
}
}
}
}
}
}
},
"/documents/{documentId}/summary": {
"get": {
"tags": [
"Documents"
],
"summary": "Retrieve document summary",
"description": "Get information about a document",
"parameters": [
{
"name": "documentId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentSummary"
},
"example": {
"documentId": "65ad9738-719a-465d-9781-8eb3a573780f",
"accountId": "af228a0e-8a0d-44eb-9163-459cf7a22d12",
"title": "House contract",
"description": "Sample avenue 42",
"lastUpdated": "2026-05-27T23:53:18Z",
"deadline": "2026-06-02T10:53:18Z",
"status": {
"documentStatus": "partialsigned"
},
"externalId": "ipoqj9r8232j54rmno2i3lmfrå2q034frlk",
"documentSignatures": [
{
"signerId": "8b9c6c3e-d82a-4c57-ade5-fe1d81dccf4e",
"externalSignerId": "oiuhw2n97483hr3w9oiufn2wi3",
"signatureMethod": "no_bankid_netcentric",
"fullName": "Superhero, Awesome",
"firstName": "Awesome",
"lastName": "Superhero",
"signedTime": "2026-05-29T05:53:18Z",
"dateOfBirth": "1984-10-21",
"signatureMethodUniqueId": "",
"socialSecurityNumber": {
"value": "21108412345",
"countryCode": "NO"
},
"clientIp": "69.89.31.226",
"mechanism": "pkisignature",
"personalInfoOrigin": "unknown"
}
],
"requiredSignatures": 2,
"currentSignatures": 1,
"tags": [
"departement4"
],
"attachments": [
"f8efd8f6-3508-4e0a-85bf-d64065db371b"
],
"signers": [
"8b9c6c3e-d82a-4c57-ade5-fe1d81dccf4e",
"3cfc9073-ab85-4879-84ef-8b8b8bc12736"
],
"created": "2026-05-27T23:53:18Z"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DocumentSummary"
},
"example": {
"documentId": "65ad9738-719a-465d-9781-8eb3a573780f",
"accountId": "af228a0e-8a0d-44eb-9163-459cf7a22d12",
"title": "House contract",
"description": "Sample avenue 42",
"lastUpdated": "2026-05-27T23:53:18Z",
"deadline": "2026-06-02T10:53:18Z",
"status": {
"documentStatus": "partialsigned"
},
"externalId": "ipoqj9r8232j54rmno2i3lmfrå2q034frlk",
"documentSignatures": [
{
"signerId": "8b9c6c3e-d82a-4c57-ade5-fe1d81dccf4e",
"externalSignerId": "oiuhw2n97483hr3w9oiufn2wi3",
"signatureMethod": "no_bankid_netcentric",
"fullName": "Superhero, Awesome",
"firstName": "Awesome",
"lastName": "Superhero",
"signedTime": "2026-05-29T05:53:18Z",
"dateOfBirth": "1984-10-21",
"signatureMethodUniqueId": "",
"socialSecurityNumber": {
"value": "21108412345",
"countryCode": "NO"
},
"clientIp": "69.89.31.226",
"mechanism": "pkisignature",
"personalInfoOrigin": "unknown"
}
],
"requiredSignatures": 2,
"currentSignatures": 1,
"tags": [
"departement4"
],
"attachments": [
"f8efd8f6-3508-4e0a-85bf-d64065db371b"
],
"signers": [
"8b9c6c3e-d82a-4c57-ade5-fe1d81dccf4e",
"3cfc9073-ab85-4879-84ef-8b8b8bc12736"
],
"created": "2026-05-27T23:53:18Z"
}
}
}
}
}
}
},
"/documents/summary": {
"get": {
"tags": [
"Documents"
],
"summary": "List document summaries",
"description": "Queries your documents using the provided parameters.",
"parameters": [
{
"name": "ExternalId",
"in": "query",
"description": "Documents external id",
"schema": {
"maxLength": 500,
"minLength": 0,
"type": "string"
}
},
{
"name": "SignerId",
"in": "query",
"description": "External signer Id",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "ExternalSignerId",
"in": "query",
"description": "External signer Id",
"schema": {
"maxLength": 500,
"minLength": 0,
"type": "string"
}
},
{
"name": "FromDate",
"in": "query",
"description": "Documents created from date",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "ToDate",
"in": "query",
"description": "Documents created to date",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "LastUpdated",
"in": "query",
"description": "Documents updated after this date",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "SignedDate",
"in": "query",
"description": "Documents signed after this date",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "NameOfSigner",
"in": "query",
"description": "Name of one of the signers",
"schema": {
"maxLength": 500,
"minLength": 0,
"type": "string"
}
},
{
"name": "Title",
"in": "query",
"description": "Filter by specific document title",
"schema": {
"maxLength": 500,
"minLength": 0,
"type": "string"
}
},
{
"name": "Status",
"in": "query",
"description": "Filter by specific document status",
"schema": {
"$ref": "#/components/schemas/DocumentStatus"
}
},
{
"name": "Tags",
"in": "query",
"description": "Filter by tags (comma separated list)",
"schema": {
"maxLength": 500,
"minLength": 0,
"type": "string"
}
},
{
"name": "Offset",
"in": "query",
"description": "Used for paging (will be automatically set in response links)",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Limit",
"in": "query",
"description": "Set how many results you want per page (max/default 100)",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentSummaryCollectionWithPaging"
},
"example": {
"offset": 0,
"limit": 2,
"size": 45,
"links": {
"next": "https://api.idfy.io/signature/documents/summary?limit=2&offset=2",
"first": "https://api.idfy.io/signature/documents/summary?limit=2"
},
"data": [
{
"documentId": "fead5d9e-c0d3-4c49-a875-db1d9b7b7f56",
"accountId": "c6ac4476-a712-4ef5-b85f-05a5c6293b42",
"title": "House contract",
"description": "Sample avenue 42",
"lastUpdated": "2026-05-27T23:53:18Z",
"deadline": "2026-06-02T10:53:18Z",
"status": {
"documentStatus": "partialsigned"
},
"externalId": "ipoqj9r8232j54rmno2i3lmfrå2q034frlk",
"documentSignatures": [
{
"signerId": "58d42ef1-e5f9-418b-9b42-2f42ad259102",
"externalSignerId": "oiuhw2n97483hr3w9oiufn2wi3",
"signatureMethod": "no_bankid_netcentric",
"fullName": "Superhero, Awesome",
"firstName": "Awesome",
"lastName": "Superhero",
"signedTime": "2026-05-29T05:53:18Z",
"dateOfBirth": "1984-10-21",
"signatureMethodUniqueId": "",
"socialSecurityNumber": {
"value": "21108412345",
"countryCode": "NO"
},
"clientIp": "69.89.31.226",
"mechanism": "pkisignature",
"personalInfoOrigin": "unknown"
}
],
"requiredSignatures": 2,
"currentSignatures": 1,
"tags": [
"departement4"
],
"attachments": [
"67e2c6fc-4574-42a2-9e43-4c0454d5cb72"
],
"signers": [
"58d42ef1-e5f9-418b-9b42-2f42ad259102",
"b1b459ee-d26a-4e1e-853a-6121f170a688"
],
"created": "2026-05-27T23:53:18Z"
},
{
"documentId": "91487c2e-2c08-4e59-8fab-fc98cd4dd6ef",
"accountId": "fee4a688-5c3c-4479-a86f-519eddf1a11e",
"title": "House contract",
"description": "Sample avenue 51",
"lastUpdated": "2026-05-27T23:53:18Z",
"deadline": "2026-06-02T10:53:18Z",
"status": {
"documentStatus": "unsigned"
},
"externalId": "9w87eht3984inf3wo0mf43p0owke",
"requiredSignatures": 2,
"currentSignatures": 0,
"tags": [
"departement4"
],
"signers": [
"b81a94cb-6f70-49bd-b5ca-209d7cb445d9",
"7c2df999-fb0b-4bc0-ba9a-b6443473118a"
],
"created": "2026-05-27T23:53:18Z"
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DocumentSummaryCollectionWithPaging"
},
"example": {
"offset": 0,
"limit": 2,
"size": 45,
"links": {
"next": "https://api.idfy.io/signature/documents/summary?limit=2&offset=2",
"first": "https://api.idfy.io/signature/documents/summary?limit=2"
},
"data": [
{
"documentId": "fead5d9e-c0d3-4c49-a875-db1d9b7b7f56",
"accountId": "c6ac4476-a712-4ef5-b85f-05a5c6293b42",
"title": "House contract",
"description": "Sample avenue 42",
"lastUpdated": "2026-05-27T23:53:18Z",
"deadline": "2026-06-02T10:53:18Z",
"status": {
"documentStatus": "partialsigned"
},
"externalId": "ipoqj9r8232j54rmno2i3lmfrå2q034frlk",
"documentSignatures": [
{
"signerId": "58d42ef1-e5f9-418b-9b42-2f42ad259102",
"externalSignerId": "oiuhw2n97483hr3w9oiufn2wi3",
"signatureMethod": "no_bankid_netcentric",
"fullName": "Superhero, Awesome",
"firstName": "Awesome",
"lastName": "Superhero",
"signedTime": "2026-05-29T05:53:18Z",
"dateOfBirth": "1984-10-21",
"signatureMethodUniqueId": "",
"socialSecurityNumber": {
"value": "21108412345",
"countryCode": "NO"
},
"clientIp": "69.89.31.226",
"mechanism": "pkisignature",
"personalInfoOrigin": "unknown"
}
],
"requiredSignatures": 2,
"currentSignatures": 1,
"tags": [
"departement4"
],
"attachments": [
"67e2c6fc-4574-42a2-9e43-4c0454d5cb72"
],
"signers": [
"58d42ef1-e5f9-418b-9b42-2f42ad259102",
"b1b459ee-d26a-4e1e-853a-6121f170a688"
],
"created": "2026-05-27T23:53:18Z"
},
{
"documentId": "91487c2e-2c08-4e59-8fab-fc98cd4dd6ef",
"accountId": "fee4a688-5c3c-4479-a86f-519eddf1a11e",
"title": "House contract",
"description": "Sample avenue 51",
"lastUpdated": "2026-05-27T23:53:18Z",
"deadline": "2026-06-02T10:53:18Z",
"status": {
"documentStatus": "unsigned"
},
"externalId": "9w87eht3984inf3wo0mf43p0owke",
"requiredSignatures": 2,
"currentSignatures": 0,
"tags": [
"departement4"
],
"signers": [
"b81a94cb-6f70-49bd-b5ca-209d7cb445d9",
"7c2df999-fb0b-4bc0-ba9a-b6443473118a"
],
"created": "2026-05-27T23:53:18Z"
}
]
}
}
}
}
}
}
},
"/documents/{documentId}/files": {
"get": {
"tags": [
"Files"
],
"summary": "Retrieve file",
"description": "Retrieves the signed document file.",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "fileFormat",
"in": "query",
"description": "",
"schema": {
"$ref": "#/components/schemas/FileFormat"
}
},
{
"name": "originalFileName",
"in": "query",
"description": "Set this to true if you want us to name the file with the original filename",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/documents/{documentId}/files/signers/{signerId}": {
"get": {
"tags": [
"Files"
],
"summary": "Retrieve file for signer",
"description": "Retrieves the signed document file for the specified signer.",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "signerId",
"in": "path",
"description": "The signers Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "fileFormat",
"in": "query",
"description": "",
"schema": {
"$ref": "#/components/schemas/SignerFileFormat"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/documents/{documentId}/files/attachments/{attachmentId}": {
"get": {
"tags": [
"Files"
],
"summary": "Retrieve attachment file",
"description": "Retrieves the attachment file.",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "attachmentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "fileFormat",
"in": "query",
"description": "",
"schema": {
"$ref": "#/components/schemas/FileFormat"
}
},
{
"name": "originalFileName",
"in": "query",
"description": "Set this to true if you want us to name the file with the original filename",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/documents/{documentId}/files/attachments/{attachmentId}/signers/{signerId}": {
"get": {
"tags": [
"Files"
],
"summary": "Retrieve attachment for signer",
"description": "Retrieves the attachment file for the specified signer.",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "attachmentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "signerId",
"in": "path",
"description": "The signers Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "fileFormat",
"in": "query",
"description": "",
"schema": {
"$ref": "#/components/schemas/SignerFileFormat"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/jwt/validate": {
"post": {
"tags": [
"Jwt"
],
"summary": "Validate redirect JWT",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ValidateJwtRequestDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidateJwtRequestDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ValidateJwtRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ValidateJwtRequestDto"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidateJwtResultDto"
},
"example": {
"valid": true,
"expires": "2026-06-04T10:53:18Z",
"payload": {
"accountId": "61071c77-699f-460d-a6fd-1f8e4a5b5e20",
"documentId": "c77b95e9-3a8d-4055-8504-c399aa33a79f",
"externalId": "soidjnmg984wmnf3osfasdcw",
"signerId": "ce6d6736-22a5-4ee0-8ccf-fc4a1823f5a9",
"externalSignerId": "ws97uh7uh7uh7uh7uh7uh7uhjm4fc4",
"signSuccess": {
"signatureMethodUniqueId": "8412125434",
"firstName": "Evil",
"lastName": "Villain",
"fullName": "Evil Villain",
"dateOfBirth": "121284",
"signatureMethod": "se_bankid",
"signedTime": "2026-05-29T10:53:18Z",
"mechanism": "pkisignature"
},
"expires": "2026-05-29T11:03:18Z",
"aborted": false
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ValidateJwtResultDto"
},
"example": {
"valid": true,
"expires": "2026-06-04T10:53:18Z",
"payload": {
"accountId": "61071c77-699f-460d-a6fd-1f8e4a5b5e20",
"documentId": "c77b95e9-3a8d-4055-8504-c399aa33a79f",
"externalId": "soidjnmg984wmnf3osfasdcw",
"signerId": "ce6d6736-22a5-4ee0-8ccf-fc4a1823f5a9",
"externalSignerId": "ws97uh7uh7uh7uh7uh7uh7uhjm4fc4",
"signSuccess": {
"signatureMethodUniqueId": "8412125434",
"firstName": "Evil",
"lastName": "Villain",
"fullName": "Evil Villain",
"dateOfBirth": "121284",
"signatureMethod": "se_bankid",
"signedTime": "2026-05-29T10:53:18Z",
"mechanism": "pkisignature"
},
"expires": "2026-05-29T11:03:18Z",
"aborted": false
}
}
}
}
}
}
}
},
"/merchant/signature": {
"post": {
"tags": [
"MerchantSign"
],
"summary": "Create merchant signature",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/MerchantSignRequest"
},
"example": {
"dataToSign": "RGV0dGUgZXIgZW4gdGVrc3Qgc29tIGthbiBzaWduZXJlcw==",
"dataFormat": "txt",
"externalReference": "Some reference",
"signingFormat": "no_bankid_seid_sdo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/MerchantSignRequest"
},
"example": {
"dataToSign": "RGV0dGUgZXIgZW4gdGVrc3Qgc29tIGthbiBzaWduZXJlcw==",
"dataFormat": "txt",
"externalReference": "Some reference",
"signingFormat": "no_bankid_seid_sdo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/MerchantSignRequest"
},
"example": {
"dataToSign": "RGV0dGUgZXIgZW4gdGVrc3Qgc29tIGthbiBzaWduZXJlcw==",
"dataFormat": "txt",
"externalReference": "Some reference",
"signingFormat": "no_bankid_seid_sdo"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/MerchantSignRequest"
},
"example": {
"dataToSign": "RGV0dGUgZXIgZW4gdGVrc3Qgc29tIGthbiBzaWduZXJlcw==",
"dataFormat": "txt",
"externalReference": "Some reference",
"signingFormat": "no_bankid_seid_sdo"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MerchantSignResponse"
},
"example": {
"signedData": "Base 64 encoded signed data",
"signingFormat": "no_bankid_seid_sdo",
"signCertificateBase64String": "Base 64 encoded certificate used to sign data",
"transactionId": "be6b0d54-0cf2-41a2-a56d-78718aa01bb3"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/MerchantSignResponse"
},
"example": {
"signedData": "Base 64 encoded signed data",
"signingFormat": "no_bankid_seid_sdo",
"signCertificateBase64String": "Base 64 encoded certificate used to sign data",
"transactionId": "be6b0d54-0cf2-41a2-a56d-78718aa01bb3"
}
}
}
}
}
}
},
"/documents/{documentId}/notifications": {
"get": {
"tags": [
"Notifications"
],
"summary": "List notifications",
"description": "Returns a list of all notifications that has been sent / attempted sent for a document",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationLogItem"
}
},
"example": [
{
"sentTimeStamp": "1/8/2018 10:58 AM",
"title": "Sample email",
"text": "email text",
"messageType": "EMAIL",
"status": "DELIVERED",
"receiver": "test@test.com"
},
{
"sentTimeStamp": "1/8/2018 10:58 AM",
"title": "Sample sms",
"text": "sms text",
"messageType": "SMS",
"status": "DELIVERED",
"receiver": "test@test.com"
}
]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationLogItem"
}
},
"example": [
{
"sentTimeStamp": "1/8/2018 10:58 AM",
"title": "Sample email",
"text": "email text",
"messageType": "EMAIL",
"status": "DELIVERED",
"receiver": "test@test.com"
},
{
"sentTimeStamp": "1/8/2018 10:58 AM",
"title": "Sample sms",
"text": "sms text",
"messageType": "SMS",
"status": "DELIVERED",
"receiver": "test@test.com"
}
]
}
}
}
}
}
},
"/documents/{documentId}/notifications/reminder": {
"post": {
"tags": [
"Notifications"
],
"summary": "Send reminders",
"description": "If you want to send out reminders to all/some of the signers manually you can do it here.",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ManualReminder"
},
"example": {
"notificationSetting": "sendEmail",
"signers": {
"be78acea-e800-47cd-91b5-ed9c1cfae484": null,
"65b215f2-505f-42fd-bd44-474afa51b7d0": {
"emailOverride": "overrideemail@test.com"
}
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManualReminder"
},
"example": {
"notificationSetting": "sendEmail",
"signers": {
"be78acea-e800-47cd-91b5-ed9c1cfae484": null,
"65b215f2-505f-42fd-bd44-474afa51b7d0": {
"emailOverride": "overrideemail@test.com"
}
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ManualReminder"
},
"example": {
"notificationSetting": "sendEmail",
"signers": {
"be78acea-e800-47cd-91b5-ed9c1cfae484": null,
"65b215f2-505f-42fd-bd44-474afa51b7d0": {
"emailOverride": "overrideemail@test.com"
}
}
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ManualReminder"
},
"example": {
"notificationSetting": "sendEmail",
"signers": {
"be78acea-e800-47cd-91b5-ed9c1cfae484": null,
"65b215f2-505f-42fd-bd44-474afa51b7d0": {
"emailOverride": "overrideemail@test.com"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManualReminder"
},
"example": {
"notificationSetting": "sendEmail",
"signers": {
"cafcc728-6de1-4fe4-9811-a5c65ba99520": null,
"7651694d-b1d5-433b-804a-15b5dc118b2f": {
"emailOverride": "overrideemail@test.com"
}
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ManualReminder"
},
"example": {
"notificationSetting": "sendEmail",
"signers": {
"cafcc728-6de1-4fe4-9811-a5c65ba99520": null,
"7651694d-b1d5-433b-804a-15b5dc118b2f": {
"emailOverride": "overrideemail@test.com"
}
}
}
}
}
}
}
}
},
"/signature-methods": {
"get": {
"tags": [
"SignatureMethods"
],
"summary": "List signature-methods",
"description": "Returns a list of all the supported signature-methods",
"parameters": [
{
"name": "mechanism",
"in": "query",
"description": "The result may vary with different signature mechanisms. Defaults to pkisignature",
"schema": {
"$ref": "#/components/schemas/Mechanisms"
}
},
{
"name": "fileType",
"in": "query",
"description": "FileType that will be signed, some signature methods have different file support. Defaults to pdf",
"schema": {
"$ref": "#/components/schemas/ListSignMethodsFileType"
}
},
{
"name": "language",
"in": "query",
"description": "The language to use for name and description. Defaults to EN (english)",
"schema": {
"$ref": "#/components/schemas/Language"
}
},
{
"name": "signableAttachments",
"in": "query",
"description": "Signing multiple documents? Some signature-methods may lack this functionality",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "redirectMode",
"in": "query",
"description": "Some signature methods do not allow iframing",
"schema": {
"$ref": "#/components/schemas/RedirectMode"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/signature-methods/account": {
"get": {
"tags": [
"SignatureMethods"
],
"summary": "List signature-methods for account",
"description": "Returns a list of all the signature-methods available for the requester's account.",
"parameters": [
{
"name": "mechanism",
"in": "query",
"description": "The result may vary with different signature mechanisms. Defaults to pkisignature",
"schema": {
"$ref": "#/components/schemas/Mechanisms"
}
},
{
"name": "fileType",
"in": "query",
"description": "FileType that will be signed, some signature methods have different file support. Defaults to pdf",
"schema": {
"$ref": "#/components/schemas/ListSignMethodsFileType"
}
},
{
"name": "language",
"in": "query",
"description": "The language to use for name and description. Defaults to EN (english)",
"schema": {
"$ref": "#/components/schemas/Language"
}
},
{
"name": "signableAttachments",
"in": "query",
"description": "Signing multiple documents? Some signature-methods may lack this functionality",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "redirectMode",
"in": "query",
"description": "Some signature methods do not allow iframing",
"schema": {
"$ref": "#/components/schemas/RedirectMode"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/documents/{documentId}/signers/{signerId}": {
"get": {
"tags": [
"Signers"
],
"summary": "Retrieve signer",
"description": "Retrieves the details of a single signer.",
"parameters": [
{
"name": "documentId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "signerId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SignerResponse"
},
"example": {
"id": "4f7fe819-3cc6-46ce-9f96-8cbf3ad0bfc8",
"url": "https://sign-test.signicat.io/init?jwt=...",
"externalSignerId": "aoijfnmo032q223",
"redirectSettings": {
"redirectMode": "redirect",
"error": "https://signicat.io#error",
"cancel": "https://signicat.io#cancel",
"success": "https://signicat.io#success"
},
"signatureType": {
"mechanism": "pkisignature"
},
"order": 0,
"required": false,
"signUrlExpires": "2026-06-01T10:53:18Z",
"getSocialSecurityNumber": false
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SignerResponse"
},
"example": {
"id": "4f7fe819-3cc6-46ce-9f96-8cbf3ad0bfc8",
"url": "https://sign-test.signicat.io/init?jwt=...",
"externalSignerId": "aoijfnmo032q223",
"redirectSettings": {
"redirectMode": "redirect",
"error": "https://signicat.io#error",
"cancel": "https://signicat.io#cancel",
"success": "https://signicat.io#success"
},
"signatureType": {
"mechanism": "pkisignature"
},
"order": 0,
"required": false,
"signUrlExpires": "2026-06-01T10:53:18Z",
"getSocialSecurityNumber": false
}
}
}
}
}
},
"delete": {
"tags": [
"Signers"
],
"summary": "Delete signer",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "signerId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"patch": {
"tags": [
"Signers"
],
"summary": "Update signer",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "signerId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateSignerRequest"
},
"example": {
"signerInfo": {
"firstName": "Updated",
"lastName": "Name"
},
"order": 0,
"required": false,
"signUrlExpires": "2026-05-31T10:53:18Z"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateSignerRequest"
},
"example": {
"signerInfo": {
"firstName": "Updated",
"lastName": "Name"
},
"order": 0,
"required": false,
"signUrlExpires": "2026-05-31T10:53:18Z"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateSignerRequest"
},
"example": {
"signerInfo": {
"firstName": "Updated",
"lastName": "Name"
},
"order": 0,
"required": false,
"signUrlExpires": "2026-05-31T10:53:18Z"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateSignerRequest"
},
"example": {
"signerInfo": {
"firstName": "Updated",
"lastName": "Name"
},
"order": 0,
"required": false,
"signUrlExpires": "2026-05-31T10:53:18Z"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateSignerResponse"
},
"example": {
"signerInfo": {
"firstName": "Updated",
"lastName": "Name"
},
"order": 0,
"required": false,
"signUrlExpires": "2026-05-31T10:53:18Z"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateSignerResponse"
},
"example": {
"signerInfo": {
"firstName": "Updated",
"lastName": "Name"
},
"order": 0,
"required": false,
"signUrlExpires": "2026-05-31T10:53:18Z"
}
}
}
}
}
}
},
"/documents/{documentId}/signers": {
"get": {
"tags": [
"Signers"
],
"summary": "List signers",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SignerResponse"
}
},
"example": [
{
"id": "73afc156-88e8-4129-b22b-6629b9d2109f",
"url": "https://sign-test.signicat.io/init?jwt=...",
"externalSignerId": "aoijfnmo032q223",
"redirectSettings": {
"redirectMode": "redirect",
"error": "https://signicat.io#error",
"cancel": "https://signicat.io#cancel",
"success": "https://signicat.io#success"
},
"signatureType": {
"mechanism": "pkisignature"
},
"order": 0,
"required": false,
"signUrlExpires": "2026-06-01T10:53:18Z",
"getSocialSecurityNumber": false
}
]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SignerResponse"
}
},
"example": [
{
"id": "73afc156-88e8-4129-b22b-6629b9d2109f",
"url": "https://sign-test.signicat.io/init?jwt=...",
"externalSignerId": "aoijfnmo032q223",
"redirectSettings": {
"redirectMode": "redirect",
"error": "https://signicat.io#error",
"cancel": "https://signicat.io#cancel",
"success": "https://signicat.io#success"
},
"signatureType": {
"mechanism": "pkisignature"
},
"order": 0,
"required": false,
"signUrlExpires": "2026-06-01T10:53:18Z",
"getSocialSecurityNumber": false
}
]
}
}
}
}
},
"post": {
"tags": [
"Signers"
],
"summary": "Create signer",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SignerRequest"
},
"example": {
"externalSignerId": "uoiahsd321982983jhrmnec2wsadm32",
"redirectSettings": {
"redirectMode": "donot_redirect"
},
"signatureType": {
"mechanism": "pkisignature"
},
"ui": {
"language": "EN",
"dialogs": {
"before": {
"useCheckBox": false,
"title": "Info",
"message": "Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."
}
},
"styling": {
"colorTheme": "Pink",
"spinner": "Cubes",
"hideTopBar": false
}
},
"order": 0,
"required": false,
"getSocialSecurityNumber": false
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SignerRequest"
},
"example": {
"externalSignerId": "uoiahsd321982983jhrmnec2wsadm32",
"redirectSettings": {
"redirectMode": "donot_redirect"
},
"signatureType": {
"mechanism": "pkisignature"
},
"ui": {
"language": "EN",
"dialogs": {
"before": {
"useCheckBox": false,
"title": "Info",
"message": "Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."
}
},
"styling": {
"colorTheme": "Pink",
"spinner": "Cubes",
"hideTopBar": false
}
},
"order": 0,
"required": false,
"getSocialSecurityNumber": false
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SignerRequest"
},
"example": {
"externalSignerId": "uoiahsd321982983jhrmnec2wsadm32",
"redirectSettings": {
"redirectMode": "donot_redirect"
},
"signatureType": {
"mechanism": "pkisignature"
},
"ui": {
"language": "EN",
"dialogs": {
"before": {
"useCheckBox": false,
"title": "Info",
"message": "Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."
}
},
"styling": {
"colorTheme": "Pink",
"spinner": "Cubes",
"hideTopBar": false
}
},
"order": 0,
"required": false,
"getSocialSecurityNumber": false
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SignerRequest"
},
"example": {
"externalSignerId": "uoiahsd321982983jhrmnec2wsadm32",
"redirectSettings": {
"redirectMode": "donot_redirect"
},
"signatureType": {
"mechanism": "pkisignature"
},
"ui": {
"language": "EN",
"dialogs": {
"before": {
"useCheckBox": false,
"title": "Info",
"message": "Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."
}
},
"styling": {
"colorTheme": "Pink",
"spinner": "Cubes",
"hideTopBar": false
}
},
"order": 0,
"required": false,
"getSocialSecurityNumber": false
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SignerResponse"
},
"example": {
"id": "bdcd5636-a32e-4ad9-8c47-a2a09df32bcd",
"url": "https://sign-test.signicat.io/init?jwt=...",
"externalSignerId": "aoijfnmo032q223",
"redirectSettings": {
"redirectMode": "redirect",
"error": "https://signicat.io#error",
"cancel": "https://signicat.io#cancel",
"success": "https://signicat.io#success"
},
"signatureType": {
"mechanism": "pkisignature"
},
"order": 0,
"required": false,
"signUrlExpires": "2026-06-01T10:53:18Z",
"getSocialSecurityNumber": false
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SignerResponse"
},
"example": {
"id": "bdcd5636-a32e-4ad9-8c47-a2a09df32bcd",
"url": "https://sign-test.signicat.io/init?jwt=...",
"externalSignerId": "aoijfnmo032q223",
"redirectSettings": {
"redirectMode": "redirect",
"error": "https://signicat.io#error",
"cancel": "https://signicat.io#cancel",
"success": "https://signicat.io#success"
},
"signatureType": {
"mechanism": "pkisignature"
},
"order": 0,
"required": false,
"signUrlExpires": "2026-06-01T10:53:18Z",
"getSocialSecurityNumber": false
}
}
}
}
}
}
},
"/documents/{documentId}/signers/{signerId}/signature": {
"delete": {
"tags": [
"Signers"
],
"summary": "Delete signature",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "signerId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/themes/list/themes": {
"get": {
"tags": [
"Themes"
],
"summary": "List themes",
"description": "This endpoint lists all the color themes you can use in our sign application",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Theme"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Theme"
}
}
}
}
}
}
}
},
"/themes/list/spinners": {
"get": {
"tags": [
"Themes"
],
"summary": "List spinners",
"description": "This endpoint lists all the spinners you can use in our sign application",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Spinner"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Spinner"
}
}
}
}
}
}
}
},
"/validate/nbid/sdo": {
"post": {
"tags": [
"Validate"
],
"summary": "Validate nbid SDO",
"description": "Validates the signatures in a SEID-SDO, to validate the SDO we use the validation component from BankID Norway. \r\nIn this endpoint you can also include the data from the original document to validate that they matches the SDO data, the same goes for the signatures\r\nTO USE THIS IN PRODUCTION, PLEASE CONTACT SIGNICAT SUPPORT",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ValidateSDORequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidateSDORequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ValidateSDORequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ValidateSDORequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidateSDOResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ValidateSDOResponse"
}
}
}
}
}
}
},
"/validate/nbid/sdo/parse": {
"post": {
"tags": [
"Validate"
],
"summary": "Parse and validate nbid sdo",
"description": "This endpoint validates and parses signature data from a SEID-SDO, to validate/parse the SDO we use the validation component from BankID Norway. \r\nThis endpoint parses the SDO to readable data and provides you with information about the signatures and document.\r\nTO USE THIS IN PRODUCTION, PLEASE CONTACT SIGNICAT SUPPORT",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ParseSDORequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ParseSDORequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ParseSDORequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ParseSDORequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ParseSDOResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ParseSDOResponse"
}
}
}
}
}
}
},
"/validate/nbid/sdo/parse/xml": {
"post": {
"tags": [
"Validate"
],
"summary": "Parse SDO to XML",
"description": "Parse Nbid SEID-SDO to xml validation format. Returns 400 if SDO is not valid",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ParseSDOXMLRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ParseSDOXMLRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ParseSDOXMLRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ParseSDOXMLRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ParseSDOXMLResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ParseSDOXMLResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AdditionalRecipient": {
"required": [
"email"
],
"type": "object",
"properties": {
"language": {
"$ref": "#/components/schemas/Language"
},
"email": {
"minLength": 1,
"type": "string",
"description": "The email address of the recipient",
"format": "email"
},
"customMergeFields": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"description": "If you have custom merge fields in the email texts, the values can be included here",
"nullable": true
}
},
"additionalProperties": false
},
"AddonSignerRequest": {
"type": "object",
"properties": {
"types": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SignerAddon"
},
"description": "A list of the addons you want to order, see documentation for more information. Additional cost will incur",
"nullable": true
}
},
"additionalProperties": false
},
"Advanced": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of tags to add to the document. These tags can be used to query for document data and will also be added to all events that are triggered for the document.",
"nullable": true
},
"attachments": {
"type": "integer",
"description": "The number of attachments this document will have. Attachments can be added [here](#operation/Attachment_Create) after the document is created.\r\nIf you set this value to 3, you MUST upload 3 attachments before anyone can sign the document.",
"format": "int32"
},
"requiredSignatures": {
"type": "integer",
"description": "The number of signatures required before the document can be sealed and marked as completed.",
"format": "int32"
},
"createdByApplication": {
"type": "string",
"description": "The name of the application that created the document. Used for Idfy statistics.",
"nullable": true
},
"getSocialSecurityNumber": {
"type": "boolean",
"description": "Determines if the social security number of all the signers should be retrieved after a successful signature.\r\nRequires a certificate with permission to retrieve SSN."
},
"timeToLive": {
"$ref": "#/components/schemas/TimeToLive"
},
"departmentId": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "The department ID to mark the invoice with.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Optional settings for advanced configuration."
},
"AttachmentListItem": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The attachment's unique identifier.",
"format": "uuid"
},
"title": {
"type": "string",
"description": "The title of the attachment which will be presented to the user.",
"nullable": true
},
"description": {
"type": "string",
"description": "An optional description of the attachment.",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/AttachmentType"
},
"fileName": {
"type": "string",
"description": "Filename with file extension. We only support PDF for attachments, set `convertToPdf` to `true` if you have a convertible file type.",
"nullable": true
}
},
"additionalProperties": false
},
"AttachmentRequest": {
"required": [
"data",
"fileName",
"title"
],
"type": "object",
"properties": {
"fileName": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Filename with file extension. We only support PDF for attachments, set `convertToPdf` to `true` if you have a convertible file type."
},
"title": {
"maxLength": 300,
"minLength": 0,
"type": "string",
"description": "The title of the attachment which will be presented to the user."
},
"data": {
"minLength": 1,
"type": "string",
"description": "Base64-encoded attachment (UTF-8-encoded)"
},
"convertToPdf": {
"type": "boolean",
"description": "Determines if the attachment should be converted to PDF. See our documentation for supported file types."
},
"signers": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "An optional list of signers that should be able to see / sign the attachment.",
"nullable": true
},
"description": {
"type": "string",
"description": "An optional description of the attachment.",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/AttachmentType"
}
},
"additionalProperties": false
},
"AttachmentResponse": {
"required": [
"fileName",
"title"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The attachment's unique identifier.",
"format": "uuid"
},
"fileName": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Filename with file extension. We only support PDF for attachments, set `convertToPdf` to `true` if you have a convertible file type."
},
"title": {
"maxLength": 300,
"minLength": 0,
"type": "string",
"description": "The title of the attachment which will be presented to the user."
},
"convertToPdf": {
"type": "boolean",
"description": "Determines if the attachment should be converted to PDF. See our documentation for supported file types."
},
"signers": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "An optional list of signers that should be able to see / sign the attachment.",
"nullable": true
},
"description": {
"type": "string",
"description": "An optional description of the attachment.",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/AttachmentType"
}
},
"additionalProperties": false
},
"AttachmentType": {
"enum": [
"show_accept",
"read_accept",
"sign"
],
"type": "string"
},
"AuthMechanism": {
"enum": [
"off",
"eid",
"smsOtp",
"eidAndSmsOtp"
],
"type": "string"
},
"Authentication": {
"type": "object",
"properties": {
"mechanism": {
"$ref": "#/components/schemas/AuthMechanism"
},
"socialSecurityNumber": {
"type": "string",
"description": "The signer's social security number.",
"nullable": true
},
"signatureMethodUniqueId": {
"type": "string",
"description": "The signer's unique ID for a signature method (for example the Norwegian BankID PID).",
"nullable": true
}
},
"additionalProperties": false,
"description": "Authentication settings for the signer."
},
"CanceledReceipt": {
"type": "object",
"properties": {
"email": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Email"
},
"description": "A list of custom email texts to use for the notification. Default texts will be used if not specified.",
"nullable": true
},
"sms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SMS"
},
"description": "A list of custom SMS texts to use for the notification. Default texts will be used if not specified.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Email/SMS notifications when a document has been cancelled and can no longer be signed."
},
"Certificate": {
"type": "object",
"properties": {
"issuerName": {
"type": "string",
"nullable": true
},
"subjectName": {
"type": "string",
"nullable": true
},
"validFromDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"validToDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"versionNumber": {
"type": "string",
"nullable": true
},
"serialNumber": {
"type": "string",
"nullable": true
},
"keyAlgorithm": {
"type": "string",
"nullable": true
},
"keySize": {
"type": "string",
"nullable": true
},
"uniqueId": {
"type": "string",
"nullable": true
},
"originator": {
"type": "string",
"nullable": true
},
"bankName": {
"type": "string",
"nullable": true
},
"dateOfBirth": {
"type": "string",
"format": "date-time",
"nullable": true
},
"policyOid": {
"type": "string",
"nullable": true
},
"commonName": {
"type": "string",
"nullable": true
},
"signingCertficate": {
"type": "string",
"nullable": true
},
"x509Certificate": {
"$ref": "#/components/schemas/X509Certificate"
},
"keyUsage": {
"type": "string",
"nullable": true
},
"emailAddress": {
"nullable": true
},
"signingTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"certificateType": {
"$ref": "#/components/schemas/CertificateType"
}
},
"additionalProperties": false
},
"CertificateType": {
"enum": [
"HSM_MERCHANT_CERTIFICATE",
"MOBILE_PERSONAL_CERTIFICATE",
"NETCENTRIC_EMPLOYEE_CERTIFICATE",
"NETCENTRIC_PERSONAL_CERTIFICATE",
"NETCENTRIC_QUALIFIED_EMPLOYEE_CERTIFICATE",
"NETCENTRIC_QUALIFIED_PERSONAL_CERTIFICATE",
"SOFT_MERCHANT_CERTIFICATE",
"UNKNOWN"
],
"type": "string"
},
"ContactDetails": {
"required": [
"email"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the company.",
"nullable": true
},
"phone": {
"type": "string",
"description": "The phone number of the company.",
"nullable": true
},
"email": {
"minLength": 1,
"type": "string",
"description": "The email address of the company.",
"format": "email"
},
"url": {
"type": "string",
"description": "The URL to the company's website.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The company's contact information."
},
"CreateDocumentRequest": {
"required": [
"contactDetails",
"externalId",
"signers",
"title"
],
"type": "object",
"properties": {
"title": {
"maxLength": 300,
"minLength": 0,
"type": "string"
},
"signers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SignerRequest"
},
"description": "List of signers for the document."
},
"dataToSign": {
"$ref": "#/components/schemas/DataToSign"
},
"contactDetails": {
"$ref": "#/components/schemas/ContactDetails"
},
"externalId": {
"maxLength": 255,
"minLength": 4,
"type": "string"
},
"description": {
"type": "string",
"description": "The description of the document job.",
"nullable": true
},
"notification": {
"$ref": "#/components/schemas/Notification"
},
"advanced": {
"$ref": "#/components/schemas/Advanced"
}
},
"additionalProperties": false
},
"CreateDocumentResponse": {
"type": "object",
"properties": {
"documentId": {
"type": "string",
"description": "The document's unique identifier.",
"format": "uuid"
},
"signers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SignerResponse"
},
"description": "List of signers for the document.",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Status"
},
"title": {
"type": "string",
"description": "The title of the document job.",
"nullable": true
},
"description": {
"type": "string",
"description": "The description of the document job.",
"nullable": true
},
"externalId": {
"type": "string",
"description": "Your reference to this document.",
"nullable": true
},
"dataToSign": {
"$ref": "#/components/schemas/DataToSign"
},
"contactDetails": {
"$ref": "#/components/schemas/ContactDetails"
},
"notification": {
"$ref": "#/components/schemas/Notification"
},
"advanced": {
"$ref": "#/components/schemas/Advanced"
}
},
"additionalProperties": false
},
"DataToSign": {
"type": "object",
"properties": {
"title": {
"maxLength": 300,
"minLength": 0,
"type": "string",
"description": "Document title (Only relevant if Base64Content is specified)",
"nullable": true
},
"description": {
"type": "string",
"description": "Document description (Only relevant if Base64Content is specified)",
"nullable": true
},
"base64Content": {
"type": "string",
"description": "Base64-encoded string of the document, UTF-8-encoded. This is optional if you have specified advanced.attachments > 0.\r\n(this field will be null after we retrieve the initial request, to retrieve the data at a later time you should use the files controller)",
"nullable": true
},
"base64ContentStyleSheet": {
"type": "string",
"description": "Stylesheet to be included if you are uploading XML.",
"nullable": true
},
"fileName": {
"maxLength": 200,
"minLength": 3,
"type": "string",
"description": "The document file name. Must include a valid file extension (.pdf, .xml, .txt, .doc, .docx, .rtf, .ott, odt).",
"nullable": true
},
"convertToPDF": {
"type": "boolean",
"description": "Determines if the document should be converted to PDF. Supported formats are word documents, rich text format, and OpenOffice (.doc, .docx, .rtf, .odt, .ott).\r\nRemark: When using this, the converted document (and not the original) is the one that will be signed."
},
"packaging": {
"$ref": "#/components/schemas/Packaging"
}
},
"additionalProperties": false,
"description": "The data that will be signed."
},
"DialogAfter": {
"type": "object",
"properties": {
"title": {
"maxLength": 100,
"type": "string",
"description": "The title of the dialog.",
"nullable": true
},
"message": {
"maxLength": 2000,
"type": "string",
"description": "The message body of the dialog.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A dialog that will be presented after the document is signed."
},
"DialogBefore": {
"type": "object",
"properties": {
"useCheckBox": {
"type": "boolean",
"description": "Determines if a the user must confirm that the dialog message has been read before they can continue."
},
"title": {
"maxLength": 100,
"type": "string",
"description": "The title of the dialog.",
"nullable": true
},
"message": {
"maxLength": 2000,
"type": "string",
"description": "The message body of the dialog.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A dialog that will be presented before the document is signed."
},
"DialogBeforeResponse": {
"type": "object",
"properties": {
"useCheckBox": {
"type": "boolean",
"description": "Determines if a the user must confirm that the dialog message has been read before they can continue."
},
"title": {
"maxLength": 100,
"type": "string",
"description": "The title of the dialog.",
"nullable": true
},
"message": {
"maxLength": 2000,
"type": "string",
"description": "The message body of the dialog.",
"nullable": true
}
},
"additionalProperties": false
},
"Dialogs": {
"type": "object",
"properties": {
"before": {
"$ref": "#/components/schemas/DialogBefore"
},
"after": {
"$ref": "#/components/schemas/DialogAfter"
}
},
"additionalProperties": false,
"description": "Dialogs that will be prestented to the signer in the signature process."
},
"DialogsResponse": {
"type": "object",
"properties": {
"before": {
"$ref": "#/components/schemas/DialogBeforeResponse"
},
"after": {
"$ref": "#/components/schemas/DialogAfter"
}
},
"additionalProperties": false
},
"DocumentSignature": {
"type": "object",
"properties": {
"signatureMethod": {
"$ref": "#/components/schemas/SignatureMethod"
},
"fullName": {
"type": "string",
"description": "The signer's full name, retrieved from the signature-method provider.",
"nullable": true
},
"firstName": {
"type": "string",
"description": "The signer's first name.",
"nullable": true
},
"lastName": {
"type": "string",
"description": "The signer's last name.",
"nullable": true
},
"middleName": {
"type": "string",
"description": "The signer's middle name.",
"nullable": true
},
"signedTime": {
"type": "string",
"description": "Time at which the signature was registered (ISO 8601).",
"format": "date-time",
"nullable": true
},
"dateOfBirth": {
"type": "string",
"description": "The signer's date of birth (yyyy-MM-dd).",
"nullable": true
},
"signatureMethodUniqueId": {
"type": "string",
"description": "The signature method unique ID.",
"nullable": true
},
"socialSecurityNumber": {
"$ref": "#/components/schemas/SocialSecurityNumber"
},
"clientIp": {
"type": "string",
"description": "The IP address of the signer.",
"nullable": true
},
"mechanism": {
"$ref": "#/components/schemas/Mechanisms"
},
"personalInfoOrigin": {
"$ref": "#/components/schemas/PersonalInfoOrigin"
},
"organization": {
"$ref": "#/components/schemas/Organization"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"description": "Additional signature attributes",
"nullable": true
}
},
"additionalProperties": false,
"description": "The document signature."
},
"DocumentStatus": {
"enum": [
"unsigned",
"waiting_for_attachments",
"partialsigned",
"signed",
"canceled",
"expired"
],
"type": "string"
},
"DocumentSummary": {
"type": "object",
"properties": {
"documentId": {
"type": "string",
"description": "Document id",
"format": "uuid"
},
"accountId": {
"type": "string",
"description": "Account id",
"format": "uuid"
},
"title": {
"type": "string",
"description": "Document title",
"nullable": true
},
"description": {
"type": "string",
"description": "Document description",
"nullable": true
},
"lastUpdated": {
"type": "string",
"description": "When was the document last updated (ISO8601)",
"format": "date-time",
"nullable": true
},
"deadline": {
"type": "string",
"description": "The sign deadline for the document (ISO8601)",
"format": "date-time",
"nullable": true
},
"signedDate": {
"type": "string",
"description": "When was all the signatures processed (ISO8601)",
"format": "date-time",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Status"
},
"externalId": {
"type": "string",
"description": "External document Id (your Id)",
"nullable": true
},
"documentSignatures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtendedDocumentSignature"
},
"description": "All the signatures received on this document",
"nullable": true
},
"requiredSignatures": {
"type": "integer",
"description": "The number of required signatures on the document",
"format": "int32"
},
"currentSignatures": {
"type": "integer",
"description": "How many signatures is completed right now",
"format": "int32"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Document tags",
"nullable": true
},
"attachments": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "A list of attachment Id's",
"nullable": true
},
"signers": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "A list of all the signers on the document",
"nullable": true
},
"created": {
"type": "string",
"description": "When the document was created (ISO 8601)",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "A summary containing core information about a document"
},
"DocumentSummaryCollectionWithPaging": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"description": "The offset of the current page.",
"format": "int32",
"nullable": true
},
"limit": {
"type": "integer",
"description": "The limit of the current paging options.",
"format": "int32",
"nullable": true
},
"size": {
"type": "integer",
"description": "The total size of the collection (irrespective of any paging options).",
"format": "int64"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentSummary"
},
"nullable": true
}
},
"additionalProperties": false
},
"Email": {
"required": [
"language"
],
"type": "object",
"properties": {
"language": {
"$ref": "#/components/schemas/Language"
},
"subject": {
"type": "string",
"description": "The email subject.",
"nullable": true
},
"text": {
"type": "string",
"description": "The email notification body. Plain text and markdown is supported.",
"nullable": true
},
"senderName": {
"type": "string",
"description": "The name to use as email sender.",
"nullable": true
}
},
"additionalProperties": false
},
"ExpiredReceipt": {
"type": "object",
"properties": {
"email": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Email"
},
"description": "A list of custom email texts to use for the notification. Default texts will be used if not specified.",
"nullable": true
},
"sms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SMS"
},
"description": "A list of custom SMS texts to use for the notification. Default texts will be used if not specified.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Email/SMS notifications when a document has expired and can no longer be signed."
},
"ExtendedDocumentSignature": {
"type": "object",
"properties": {
"signerId": {
"type": "string",
"description": "The signer's unique identifier.",
"format": "uuid"
},
"externalSignerId": {
"type": "string",
"description": "Your reference for the signer.",
"nullable": true
},
"signatureMethod": {
"$ref": "#/components/schemas/SignatureMethod"
},
"fullName": {
"type": "string",
"description": "The signer's full name, retrieved from the signature-method provider.",
"nullable": true
},
"firstName": {
"type": "string",
"description": "The signer's first name.",
"nullable": true
},
"lastName": {
"type": "string",
"description": "The signer's last name.",
"nullable": true
},
"middleName": {
"type": "string",
"description": "The signer's middle name.",
"nullable": true
},
"signedTime": {
"type": "string",
"description": "Time at which the signature was registered (ISO 8601).",
"format": "date-time",
"nullable": true
},
"dateOfBirth": {
"type": "string",
"description": "The signer's date of birth (yyyy-MM-dd).",
"nullable": true
},
"signatureMethodUniqueId": {
"type": "string",
"description": "The signature method unique ID.",
"nullable": true
},
"socialSecurityNumber": {
"$ref": "#/components/schemas/SocialSecurityNumber"
},
"clientIp": {
"type": "string",
"description": "The IP address of the signer.",
"nullable": true
},
"mechanism": {
"$ref": "#/components/schemas/Mechanisms"
},
"personalInfoOrigin": {
"$ref": "#/components/schemas/PersonalInfoOrigin"
},
"organization": {
"$ref": "#/components/schemas/Organization"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"description": "Additional signature attributes",
"nullable": true
}
},
"additionalProperties": false
},
"ExtraInfoSignerRequest": {
"type": "object",
"properties": {
"types": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SignerExtraInfo"
},
"description": "A list of the extra information you want to order, in production this has to be configured on your account by Signicat. Additional cost may incur.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Settings for extra information to collect about the signer."
},
"FileFormat": {
"enum": [
"unsigned",
"native",
"standard_packaging",
"pades",
"xades"
],
"type": "string"
},
"FinalReceipt": {
"type": "object",
"properties": {
"additionalRecipients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalRecipient"
},
"description": "The receipt may be sent to persons that are not a signer on this document, by adding a recipient to this list",
"nullable": true
},
"includeSignedFile": {
"type": "boolean",
"description": "Determines if you want to include the signed main document as an attachment to the email notification.\r\nNot recommended for sensitive documents. If you use the share-addon on a signer this property will be ignored (considered as false)."
},
"email": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Email"
},
"description": "A list of custom email texts to use for the notification. Default texts will be used if not specified.",
"nullable": true
},
"sms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SMS"
},
"description": "A list of custom SMS texts to use for the notification. Default texts will be used if not specified.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Email/SMS notifications as a receipt when a document has received all required signatures."
},
"IdentificatorType": {
"enum": [
"Unknown",
"BankIDUniqueId",
"SSN",
"OrganizationNumber"
],
"type": "string"
},
"Language": {
"enum": [
"EN",
"NO",
"DA",
"SV",
"FI",
"NL",
"DE"
],
"type": "string"
},
"Link": {
"type": "object",
"properties": {
"href": {
"type": "string",
"nullable": true
},
"rel": {
"type": "string",
"nullable": true
},
"contentType": {
"type": "string",
"nullable": true
},
"error": {
"type": "string",
"nullable": true
},
"resourceStatus": {
"$ref": "#/components/schemas/ResourceStatus"
}
},
"additionalProperties": false
},
"Links": {
"type": "object",
"properties": {
"next": {
"type": "string",
"nullable": true
},
"previous": {
"type": "string",
"nullable": true
},
"first": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ListSignMethodsFileType": {
"enum": [
"pdf",
"txt",
"xml"
],
"type": "string"
},
"ManualReminder": {
"required": [
"notificationSetting"
],
"type": "object",
"properties": {
"notificationSetting": {
"$ref": "#/components/schemas/NotificationSetting"
},
"signers": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/SignerOverrides"
},
"description": "Optional: Define the signers that should receive this reminder (if not signed). Dictionary with signer id as key, you can ovveride the signer email/phone as value",
"nullable": true
}
},
"additionalProperties": false
},
"Mechanisms": {
"enum": [
"pkisignature",
"identification",
"handwritten",
"handwritten_with_identification"
],
"type": "string"
},
"MerchantDataFormat": {
"enum": [
"xml",
"txt",
"pdf"
],
"type": "string"
},
"MerchantEncodingFormat": {
"enum": [
"UTF8",
"ISOLATIN"
],
"type": "string"
},
"MerchantSignError": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"format": "int32"
},
"errorDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"MerchantSignRequest": {
"required": [
"dataFormat",
"dataToSign",
"externalReference"
],
"type": "object",
"properties": {
"dataToSign": {
"minLength": 1,
"type": "string",
"description": "Base 64 encoded data"
},
"xslt": {
"type": "string",
"description": "Base 64 encoded xslt (optional)",
"nullable": true
},
"dataFormat": {
"$ref": "#/components/schemas/MerchantDataFormat"
},
"dataEncodingFormat": {
"$ref": "#/components/schemas/MerchantEncodingFormat"
},
"externalReference": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "The service reference for the signing. Will be used for auditlog, and invoicing"
},
"signingFormat": {
"$ref": "#/components/schemas/MerchantSigningFormat"
},
"departmentId": {
"maxLength": 110,
"type": "string",
"description": "Set this if a specific department should be invoiced",
"nullable": true
}
},
"additionalProperties": false
},
"MerchantSignResponse": {
"type": "object",
"properties": {
"signedData": {
"type": "string",
"description": "base 64 encoded signed data",
"nullable": true
},
"signingFormat": {
"$ref": "#/components/schemas/MerchantSigningFormat"
},
"error": {
"$ref": "#/components/schemas/MerchantSignError"
},
"signCertificateBase64String": {
"type": "string",
"description": "Signed with certificate",
"nullable": true,
"deprecated": true
},
"transactionId": {
"type": "string",
"description": "Id to look up the transaction at a later time",
"format": "uuid"
},
"signedDocumentId": {
"type": "string",
"description": "Id to retrieve signed file (pades)",
"format": "uuid",
"nullable": true
},
"departmentId": {
"type": "string",
"nullable": true
},
"dataEncodingFormat": {
"$ref": "#/components/schemas/MerchantEncodingFormat"
}
},
"additionalProperties": false
},
"MerchantSigningFormat": {
"enum": [
"use_provider_setting",
"no_bankid_seid_sdo"
],
"type": "string"
},
"Mobile": {
"type": "object",
"properties": {
"countryCode": {
"type": "string",
"description": "The country calling code, e.g. `+47` for a norwegian number. Country calling codes on Wikipedia",
"nullable": true
},
"number": {
"type": "string",
"description": "The mobile number.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The signer's mobile number. Define this if you are using notifications."
},
"Notification": {
"type": "object",
"properties": {
"signRequest": {
"$ref": "#/components/schemas/SignRequest"
},
"reminder": {
"$ref": "#/components/schemas/Reminder"
},
"signatureReceipt": {
"$ref": "#/components/schemas/SignatureReceipt"
},
"finalReceipt": {
"$ref": "#/components/schemas/FinalReceipt"
},
"canceledReceipt": {
"$ref": "#/components/schemas/CanceledReceipt"
},
"expiredReceipt": {
"$ref": "#/components/schemas/ExpiredReceipt"
}
},
"additionalProperties": false,
"description": "Settings for custom notification texts as well as additional email addresses to receive the signed document under finalReceipt. Remark: Also requires you to setup notifications for each signer you want to notify."
},
"NotificationLogItem": {
"type": "object",
"properties": {
"sentTimeStamp": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"messageType": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
},
"fromAddress": {
"type": "string",
"nullable": true
},
"receiver": {
"type": "string",
"nullable": true
},
"senderName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"NotificationSetting": {
"enum": [
"off",
"sendSms",
"sendEmail",
"sendBoth"
],
"type": "string"
},
"Notifications": {
"type": "object",
"properties": {
"setup": {
"type": "object",
"properties": {
"request": {
"$ref": "#/components/schemas/NotificationSetting"
},
"reminder": {
"$ref": "#/components/schemas/NotificationSetting"
},
"signatureReceipt": {
"$ref": "#/components/schemas/NotificationSetting"
},
"finalReceipt": {
"$ref": "#/components/schemas/NotificationSetting"
},
"canceled": {
"$ref": "#/components/schemas/NotificationSetting"
},
"expired": {
"$ref": "#/components/schemas/NotificationSetting"
}
},
"additionalProperties": false,
"description": "Notification setup for the signer. All notifications defaults to `\"off\"`.",
"nullable": true
},
"mergeFields": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"description": "If you create your own notifications texts (See the root object -> Notification), you can create your own merge fields with your own keys. \r\nYou can then specify the text you want to insert in these fields per signer in this dictionary. Set the dictionary key to the same value as the merge field value in your notification text, and the value to the text you want us to merge in.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Email/SMS notification settings for the signer."
},
"Organization": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"organizationNumber": {
"type": "string",
"nullable": true
},
"country": {
"type": "string",
"description": "ISO 3166-1 country code.",
"nullable": true
}
},
"additionalProperties": false
},
"OrganizationInfo": {
"type": "object",
"properties": {
"orgNo": {
"maxLength": 200,
"type": "string",
"nullable": true
},
"companyName": {
"maxLength": 200,
"type": "string",
"description": "Which company does the signer represent? Can merged into the PadES-frontpage (in PadES setting set)",
"nullable": true
},
"countryCode": {
"maxLength": 10,
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "The signer's organization info."
},
"Packaging": {
"type": "object",
"properties": {
"signaturePackageFormats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SignaturePackageFormat"
},
"description": "A list of signature formats that will be created and made available for download after the document is signed.\r\nSee our documentation for more information about these formats. The native package format is included automatically (i.e. BankID SDO).",
"nullable": true
},
"padesSettings": {
"$ref": "#/components/schemas/PadesSettings"
}
},
"additionalProperties": false,
"description": "Settings for packaging of the signed document."
},
"PadesSettings": {
"type": "object",
"properties": {
"primaryLanguage": {
"$ref": "#/components/schemas/Language"
},
"secondaryLanguage": {
"$ref": "#/components/schemas/Language"
},
"padesTemplateId": {
"type": "string",
"description": "The unique ID of PAdES template to use. Can be used if you have previously created your own custom template.",
"nullable": true
},
"includeSsnInPades": {
"type": "boolean",
"description": "If you set this to true, the signers ssn / national Id will be visible in the pades file, and in the standard_packaging files",
"nullable": true
}
},
"additionalProperties": false,
"description": "PAdES settings that can be defined if the `\"pades\"` package format is selected."
},
"ParseSDORequest": {
"type": "object",
"properties": {
"sdoData": {
"type": "string",
"nullable": true
},
"externalReference": {
"type": "string",
"nullable": true
},
"fetchSSN": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"ParseSDOResponse": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"nullable": true
},
"auditId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"signersValid": {
"type": "boolean",
"nullable": true
},
"seal": {
"$ref": "#/components/schemas/Seal"
},
"signers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SDOSigner"
},
"nullable": true
},
"summary": {
"type": "string",
"nullable": true
},
"validationError": {
"$ref": "#/components/schemas/ValidationError"
},
"signedData": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ParseSDOXMLRequest": {
"type": "object",
"properties": {
"sdoData": {
"type": "string",
"description": "Base 64 encoded SDO (Signed document)",
"nullable": true
},
"externalReference": {
"type": "string",
"description": "Your reference to the parse session",
"nullable": true
}
},
"additionalProperties": false
},
"ParseSDOXMLResponse": {
"type": "object",
"properties": {
"responseType": {
"type": "string",
"nullable": true
},
"responseId": {
"type": "string",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ParseSDOXMLResponseItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"ParseSDOXMLResponseItem": {
"type": "object",
"properties": {
"objectId": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"contentType": {
"type": "string",
"nullable": true
},
"b64Data": {
"type": "string",
"nullable": true
},
"b64Rule": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"PersonalInfoOrigin": {
"enum": [
"unknown",
"eid",
"userFormInput"
],
"type": "string"
},
"RedirectMode": {
"enum": [
"donot_redirect",
"redirect",
"iframe_with_webmessaging",
"iframe_with_redirect",
"iframe_with_redirect_and_webmessaging"
],
"type": "string"
},
"RedirectSettings": {
"required": [
"redirectMode"
],
"type": "object",
"properties": {
"redirectMode": {
"$ref": "#/components/schemas/RedirectMode"
},
"domain": {
"type": "string",
"description": "The domain your website is hosted on. Required if you specify one of the iframe redirect modes for the signer.",
"nullable": true
},
"error": {
"type": "string",
"description": "The URL that the signer is redirected to if something goes wrong. Required if you use redirect for the signer.",
"nullable": true
},
"cancel": {
"type": "string",
"description": "The URL that the signer is redirected to if the signing is cancelled. Required if you use redirect for the signer.",
"nullable": true
},
"success": {
"type": "string",
"description": "The URL that the signer is redirected to after a successful signing. Required if you use redirect for the signer.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Settings for redirect."
},
"Reminder": {
"required": [
"chronSchedule"
],
"type": "object",
"properties": {
"chronSchedule": {
"minLength": 1,
"type": "string",
"description": "Defines a cron expression that control the interval of the reminders (Use UTC time). We use Quartz cron expressions, read more about it here: http://www.quartz-scheduler.org/documentation/quartz-2.x/tutorials/crontrigger.html.\r\nSorry for the spelling mistake :("
},
"firstReminderAfter": {
"type": "string",
"description": "No reminders will be sent before this date (optional)",
"format": "date-time",
"nullable": true
},
"maxReminders": {
"type": "integer",
"description": "The maximum number of reminders to be sent for each signer.",
"format": "int32",
"nullable": true
},
"email": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Email"
},
"description": "A list of custom email texts to use for the notification. Default texts will be used if not specified.",
"nullable": true
},
"sms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SMS"
},
"description": "A list of custom SMS texts to use for the notification. Default texts will be used if not specified.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Email/SMS notifications reminding the signers that they have an unsigned document."
},
"ResourceStatus": {
"enum": [
"Unknown",
"NotReady",
"Success",
"Error",
"NotFound",
"BadInput",
"ServiceUnavailable",
"Unauthorized",
"TimeOut"
],
"type": "string"
},
"SDOSigner": {
"type": "object",
"properties": {
"certificate": {
"$ref": "#/components/schemas/Certificate"
},
"name": {
"type": "string",
"nullable": true
},
"dateOfBirth": {
"type": "string",
"format": "date-time",
"nullable": true
},
"pid": {
"type": "string",
"nullable": true
},
"ssn": {
"type": "string",
"nullable": true
},
"signedTimestamp": {
"type": "string",
"format": "date-time",
"nullable": true
},
"valid": {
"type": "boolean",
"nullable": true
},
"ocsp": {
"type": "string",
"nullable": true
},
"environment": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SMS": {
"required": [
"language"
],
"type": "object",
"properties": {
"language": {
"$ref": "#/components/schemas/Language"
},
"text": {
"type": "string",
"description": "The SMS notification text.",
"nullable": true
},
"sender": {
"maxLength": 11,
"type": "string",
"description": "The name to use as SMS sender.",
"nullable": true
}
},
"additionalProperties": false
},
"Seal": {
"type": "object",
"properties": {
"sealedBy": {
"type": "string",
"nullable": true
},
"sealedTimestamp": {
"type": "string",
"format": "date-time",
"nullable": true
},
"certificate": {
"$ref": "#/components/schemas/Certificate"
},
"sealValid": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"Security": {
"type": "object",
"properties": {
"oneTimeUse": {
"type": "boolean",
"description": "(Coming soon) Determines if the link is one-time use."
},
"ipWhiteList": {
"type": "array",
"items": {
"type": "string"
},
"description": "(Coming soon) A list of IP addresses that are allowed to see / sign the document.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Security settings."
},
"SignRequest": {
"type": "object",
"properties": {
"includeOriginalFile": {
"type": "boolean",
"description": "Determines if you want to include the unsigned main document as an attachment to the email notification."
},
"email": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Email"
},
"description": "A list of custom email texts to use for the notification. Default texts will be used if not specified.",
"nullable": true
},
"sms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SMS"
},
"description": "A list of custom SMS texts to use for the notification. Default texts will be used if not specified.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Email/SMS notifications reminding the signers that they have received a new document to sign."
},
"SignatureMethod": {
"enum": [
"no_buypass",
"se_bankid",
"dk_nemid",
"fi_eid",
"sms_otp",
"unknown",
"no_bankid_mobile",
"no_bankid_netcentric",
"itsme",
"idin",
"digid",
"eherkenning",
"mitid",
"no_bankid_oidc",
"sk_mobileid",
"sk_smartid",
"et_smartcard",
"no_bankid_csc"
],
"type": "string"
},
"SignaturePackageFormat": {
"enum": [
"pades",
"native"
],
"type": "string"
},
"SignatureReceipt": {
"type": "object",
"properties": {
"email": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Email"
},
"description": "A list of custom email texts to use for the notification. Default texts will be used if not specified.",
"nullable": true
},
"sms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SMS"
},
"description": "A list of custom SMS texts to use for the notification. Default texts will be used if not specified.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Email/SMS notifications as a receipt for a successful signature."
},
"SignatureType": {
"required": [
"mechanism"
],
"type": "object",
"properties": {
"signatureMethods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SignatureMethod"
},
"description": "A list of signature methods that the signer is allowed to use when signing the document.\r\nIf not specified, all available signature methods for your Idfy account will be displayed to the signer.",
"nullable": true
},
"mechanism": {
"$ref": "#/components/schemas/Mechanisms"
}
},
"additionalProperties": false,
"description": "Settings for the allowed signature methods."
},
"Signer": {
"type": "object",
"properties": {
"identificator": {
"type": "string",
"nullable": true
},
"identificatorType": {
"$ref": "#/components/schemas/IdentificatorType"
}
},
"additionalProperties": false
},
"SignerAddon": {
"enum": [
"secureShare"
],
"type": "string"
},
"SignerExtraInfo": {
"enum": [
"personLookup"
],
"type": "string"
},
"SignerFileFormat": {
"enum": [
"native",
"packaged"
],
"type": "string"
},
"SignerInfo": {
"type": "object",
"properties": {
"firstName": {
"maxLength": 300,
"type": "string",
"description": "The signer's first name.",
"nullable": true
},
"lastName": {
"maxLength": 300,
"type": "string",
"description": "The signer's last name.",
"nullable": true
},
"email": {
"maxLength": 300,
"type": "string",
"description": "The signer's email adress. Define this if you are using notifications.",
"format": "email",
"nullable": true
},
"socialSecurityNumber": {
"maxLength": 30,
"type": "string",
"description": "Can be used to verify signer's identity by also setting the signer.VerifySocialSecurityNumber, or to prefill ssn/national Id in some of the eId's.",
"nullable": true
},
"dateOfBirth": {
"maxLength": 10,
"pattern": "^((?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][0-9])",
"type": "string",
"description": "Can be used to prefill/autostart some of the eids, must follow this pattern: YYYY-MM-DD",
"nullable": true
},
"title": {
"maxLength": 200,
"type": "string",
"description": "Give the signer a title (i.e CTO, Buyer, Customer, Lord..), this title may be merged into the PAdES-frontpage (in PAdES setting set)",
"nullable": true
},
"mobile": {
"$ref": "#/components/schemas/Mobile"
},
"organizationInfo": {
"$ref": "#/components/schemas/OrganizationInfo"
}
},
"additionalProperties": false,
"description": "Information about the signer."
},
"SignerOverrides": {
"type": "object",
"properties": {
"emailOverride": {
"type": "string",
"description": "Set a new email address on the signer (all fututre notifications to this specific signer will be sent to this email)",
"nullable": true
},
"mobileOverride": {
"$ref": "#/components/schemas/Mobile"
}
},
"additionalProperties": false
},
"SignerRequest": {
"required": [
"externalSignerId",
"redirectSettings",
"signatureType"
],
"type": "object",
"properties": {
"externalSignerId": {
"maxLength": 255,
"minLength": 4,
"type": "string",
"description": "Your reference for the signer."
},
"redirectSettings": {
"$ref": "#/components/schemas/RedirectSettings"
},
"signatureType": {
"$ref": "#/components/schemas/SignatureType"
},
"signerInfo": {
"$ref": "#/components/schemas/SignerInfo"
},
"authentication": {
"$ref": "#/components/schemas/Authentication"
},
"extraInfo": {
"$ref": "#/components/schemas/ExtraInfoSignerRequest"
},
"addons": {
"$ref": "#/components/schemas/AddonSignerRequest"
},
"ui": {
"$ref": "#/components/schemas/UI"
},
"notifications": {
"$ref": "#/components/schemas/Notifications"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Coming soon.",
"nullable": true
},
"order": {
"type": "integer",
"description": "Optional order of signing for the signer.",
"format": "int32"
},
"required": {
"type": "boolean",
"description": "Determines if the signer is required to sign the document before other signers. Any other signers will not be allowed to sign before all required signers have signed the document."
},
"signUrlExpires": {
"type": "string",
"description": "The time at which the signature URL expires (ISO 8601). Specify this if you want a limited time-to-live for the URL. Defaults to the lifetime of the document.",
"format": "date-time",
"nullable": true
},
"getSocialSecurityNumber": {
"type": "boolean",
"description": "Get social security number for this signer only (The global variable advanced.getSocialSecurityNumber will ovveride this when sat to true).\r\nRequires eid with permission to retrieve social security number"
},
"verifySocialSecurityNumber": {
"type": "boolean",
"description": "Get and verify social security number for this signer, if there is a mismatch the signature will fail.\r\nRequirements: 1) signerInfo.SocialSecurityNumber must be prefilled, 2) eID with permission to retrieve social security number.\r\nIf the eID does not return a social security number this property will be ignored.",
"nullable": true
}
},
"additionalProperties": false
},
"SignerResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The signer's unique identifier.",
"format": "uuid"
},
"url": {
"type": "string",
"description": "The URL that the signer must use to sign the document.",
"nullable": true
},
"documentSignature": {
"$ref": "#/components/schemas/DocumentSignature"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Link"
},
"description": "HATEOAS extrainfo links retrieved for signer.",
"nullable": true
},
"ui": {
"$ref": "#/components/schemas/UIResponse"
},
"externalSignerId": {
"type": "string",
"description": "Your reference for the signer.",
"nullable": true
},
"redirectSettings": {
"$ref": "#/components/schemas/RedirectSettings"
},
"signatureType": {
"$ref": "#/components/schemas/SignatureType"
},
"signerInfo": {
"$ref": "#/components/schemas/SignerInfo"
},
"authentication": {
"$ref": "#/components/schemas/Authentication"
},
"extraInfo": {
"$ref": "#/components/schemas/ExtraInfoSignerRequest"
},
"addons": {
"$ref": "#/components/schemas/AddonSignerRequest"
},
"notifications": {
"$ref": "#/components/schemas/Notifications"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Coming soon.",
"nullable": true
},
"order": {
"type": "integer",
"description": "Optional order of signing for the signer.",
"format": "int32"
},
"required": {
"type": "boolean",
"description": "Determines if the signer is required to sign the document before other signers. Any other signers will not be allowed to sign before all required signers have signed the document."
},
"signUrlExpires": {
"type": "string",
"description": "The time at which the signature URL expires (ISO 8601). Specify this if you want a limited time-to-live for the URL. Defaults to the lifetime of the document.",
"format": "date-time",
"nullable": true
},
"getSocialSecurityNumber": {
"type": "boolean",
"description": "Get social security number for this signer only (The global variable advanced.getSocialSecurityNumber will ovveride this when sat to true).\r\nRequires eid with permission to retrieve social security number"
},
"verifySocialSecurityNumber": {
"type": "boolean",
"description": "Get and verify social security number for this signer, if there is a mismatch the signature will fail.\r\nRequirements: 1) signerInfo.SocialSecurityNumber must be prefilled, 2) eID with permission to retrieve social security number.\r\nIf the eID does not return a social security number this property will be ignored.",
"nullable": true
}
},
"additionalProperties": false
},
"SocialSecurityNumber": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The social security number.",
"nullable": true
},
"countryCode": {
"type": "string",
"description": "ISO 3166-1 Alfa-2 (2 letters) country code.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The signer's social security number. Will be retrieved only when `getSocialSecurityNumber` is specified when creating the document."
},
"Spinner": {
"enum": [
"Document",
"Classic",
"Cubes",
"Bounce"
],
"type": "string"
},
"Status": {
"type": "object",
"properties": {
"documentStatus": {
"$ref": "#/components/schemas/DocumentStatus"
},
"completedPackages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileFormat"
},
"description": "A list of all the completed files/packages for the main document.",
"nullable": true
},
"attachmentPackages": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileFormat"
},
"nullable": true
},
"description": "A set of key-value pairs with all the completed packages for the signable attachments, where the key is equal to the attachment's ID.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The status of the document."
},
"Styling": {
"type": "object",
"properties": {
"colorTheme": {
"$ref": "#/components/schemas/Theme"
},
"themeMode": {
"$ref": "#/components/schemas/ThemeMode"
},
"spinner": {
"$ref": "#/components/schemas/Spinner"
},
"topBar": {
"$ref": "#/components/schemas/TopBarMode"
},
"backgroundColor": {
"type": "string",
"description": "Override the application background color (use hexadecimal value)",
"nullable": true
}
},
"additionalProperties": false,
"description": "Customize styling to make the the signature application look perfect in combination with your own application."
},
"Theme": {
"enum": [
"Default",
"Black",
"Blue",
"Cyan",
"Dark",
"Lime",
"Neutral",
"Pink",
"Purple",
"Red",
"Teal",
"Indigo",
"LightBlue",
"DeepPurple",
"Green",
"LightGreen",
"Yellow",
"Amber",
"Orange",
"DeepOrange",
"Brown",
"Gray",
"BlueGray",
"OceanGreen",
"GreenOcean",
"Idfy",
"Signicat"
],
"type": "string"
},
"ThemeMode": {
"enum": [
"Default",
"Light",
"Dark"
],
"type": "string"
},
"TimeToLive": {
"type": "object",
"properties": {
"deadline": {
"type": "string",
"description": "Time at which the document will expire (ISO 8601). The document can not be signed after this time. Default/maximum 45 days.",
"format": "date-time",
"nullable": true
},
"deleteAfterHours": {
"type": "integer",
"description": "How many hours we will keep the document after it is signed or expired (deadline). The default is 168 hours (7 days), and the maximum is 744 hours (31 days). After this timespan the document and files will be permanently deleted on our side.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Time-to-live settings for the document."
},
"TopBarMode": {
"enum": [
"Default",
"Visible",
"OnlyMenu",
"Hidden"
],
"type": "string"
},
"UI": {
"type": "object",
"properties": {
"language": {
"$ref": "#/components/schemas/Language"
},
"dialogs": {
"$ref": "#/components/schemas/Dialogs"
},
"styling": {
"$ref": "#/components/schemas/Styling"
}
},
"additionalProperties": false,
"description": "UI settings for the signature process."
},
"UIResponse": {
"type": "object",
"properties": {
"dialogs": {
"$ref": "#/components/schemas/DialogsResponse"
},
"language": {
"$ref": "#/components/schemas/Language"
},
"styling": {
"$ref": "#/components/schemas/Styling"
}
},
"additionalProperties": false
},
"UpdateAttachmentRequest": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/AttachmentType"
},
"fileName": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Filename with file extension. We only support PDF for attachments, set `convertToPdf` to `true` if you have a convertible file type.",
"nullable": true
},
"title": {
"maxLength": 300,
"minLength": 0,
"type": "string",
"description": "The title of the attachment which will be presented to the user.",
"nullable": true
},
"data": {
"type": "string",
"description": "Base64-encoded attachment (UTF-8-encoded)",
"nullable": true
},
"convertToPdf": {
"type": "boolean",
"description": "Determines if the attachment should be converted to PDF. See our documentation for supported file types."
},
"signers": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "An optional list of signers that should be able to see / sign the attachment.",
"nullable": true
},
"description": {
"type": "string",
"description": "An optional description of the attachment.",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateDocumentRequest": {
"type": "object",
"properties": {
"title": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"notification": {
"$ref": "#/components/schemas/Notification"
},
"contactDetails": {
"$ref": "#/components/schemas/ContactDetails"
},
"advanced": {
"$ref": "#/components/schemas/Advanced"
}
},
"additionalProperties": false
},
"UpdateSignerRequest": {
"type": "object",
"properties": {
"externalSignerId": {
"maxLength": 255,
"minLength": 4,
"type": "string",
"description": "Your reference for the signer.",
"nullable": true
},
"redirectSettings": {
"$ref": "#/components/schemas/RedirectSettings"
},
"signatureType": {
"$ref": "#/components/schemas/SignatureType"
},
"signerInfo": {
"$ref": "#/components/schemas/SignerInfo"
},
"authentication": {
"$ref": "#/components/schemas/Authentication"
},
"extraInfo": {
"$ref": "#/components/schemas/ExtraInfoSignerRequest"
},
"addons": {
"$ref": "#/components/schemas/AddonSignerRequest"
},
"ui": {
"$ref": "#/components/schemas/UIResponse"
},
"notifications": {
"$ref": "#/components/schemas/Notifications"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Coming soon.",
"nullable": true
},
"order": {
"type": "integer",
"description": "Optional order of signing for the signer.",
"format": "int32"
},
"required": {
"type": "boolean",
"description": "Determines if the signer is required to sign the document before other signers. Any other signers will not be allowed to sign before all required signers have signed the document."
},
"signUrlExpires": {
"type": "string",
"description": "The time at which the signature URL expires (ISO 8601). Specify this if you want a limited time-to-live for the URL. Defaults to the lifetime of the document.",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateSignerResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The signer's unique identifier.",
"format": "uuid"
},
"url": {
"type": "string",
"description": "The URL that the signer must use to sign the document.",
"nullable": true
},
"documentSignature": {
"$ref": "#/components/schemas/DocumentSignature"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Link"
},
"description": "HATEOAS extrainfo links retrieved for signer.",
"nullable": true
},
"ui": {
"$ref": "#/components/schemas/UIResponse"
},
"externalSignerId": {
"type": "string",
"description": "Your reference for the signer.",
"nullable": true
},
"redirectSettings": {
"$ref": "#/components/schemas/RedirectSettings"
},
"signatureType": {
"$ref": "#/components/schemas/SignatureType"
},
"signerInfo": {
"$ref": "#/components/schemas/SignerInfo"
},
"authentication": {
"$ref": "#/components/schemas/Authentication"
},
"extraInfo": {
"$ref": "#/components/schemas/ExtraInfoSignerRequest"
},
"addons": {
"$ref": "#/components/schemas/AddonSignerRequest"
},
"notifications": {
"$ref": "#/components/schemas/Notifications"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Coming soon.",
"nullable": true
},
"order": {
"type": "integer",
"description": "Optional order of signing for the signer.",
"format": "int32"
},
"required": {
"type": "boolean",
"description": "Determines if the signer is required to sign the document before other signers. Any other signers will not be allowed to sign before all required signers have signed the document."
},
"signUrlExpires": {
"type": "string",
"description": "The time at which the signature URL expires (ISO 8601). Specify this if you want a limited time-to-live for the URL. Defaults to the lifetime of the document.",
"format": "date-time",
"nullable": true
},
"getSocialSecurityNumber": {
"type": "boolean",
"description": "Get social security number for this signer only (The global variable advanced.getSocialSecurityNumber will ovveride this when sat to true).\r\nRequires eid with permission to retrieve social security number"
},
"verifySocialSecurityNumber": {
"type": "boolean",
"description": "Get and verify social security number for this signer, if there is a mismatch the signature will fail.\r\nRequirements: 1) signerInfo.SocialSecurityNumber must be prefilled, 2) eID with permission to retrieve social security number.\r\nIf the eID does not return a social security number this property will be ignored.",
"nullable": true
}
},
"additionalProperties": false
},
"ValidateJwtRequestDto": {
"required": [
"jwt"
],
"type": "object",
"properties": {
"jwt": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"ValidateJwtResultDto": {
"type": "object",
"properties": {
"valid": {
"type": "boolean"
},
"expires": {
"type": "string",
"format": "date-time",
"nullable": true
},
"payload": {
"nullable": true
},
"error": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ValidateSDORequest": {
"type": "object",
"properties": {
"sdoData": {
"type": "string",
"nullable": true
},
"externalReference": {
"type": "string",
"nullable": true
},
"dataToValidate": {
"type": "string",
"nullable": true
},
"signersToValidate": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Signer"
},
"nullable": true
}
},
"additionalProperties": false
},
"ValidateSDOResponse": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"nullable": true
},
"valid": {
"type": "boolean",
"nullable": true
},
"seal": {
"$ref": "#/components/schemas/Seal"
},
"signers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidatedSigner"
},
"nullable": true
},
"summary": {
"type": "string",
"nullable": true
},
"validationError": {
"$ref": "#/components/schemas/ValidationError"
},
"auditId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"ValidatedSigner": {
"type": "object",
"properties": {
"identificator": {
"type": "string",
"nullable": true
},
"identificatorType": {
"$ref": "#/components/schemas/IdentificatorType"
},
"valid": {
"type": "boolean",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ValidationError": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"X509Certificate": {
"type": "object",
"properties": {
"rawData": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
}
}
}