# Signicat

> Upload documents, manage document collections and signing sessions with Signicat Sign API v2.

App · 14 actions. Web page: https://docs.lodol.com/docs/integrations/signicat

## Actions

### Cancel signing session

Delete a signing session.

**Inputs**

- Signing session (`session_id`, text, required): The unique ID of the session.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {}
}
```

### Create collection

Create a new document collection.

**Inputs**

- Documents (`documents`, list, required): Documents.
- Package to (`package_to`, list): A list of formats the collection should be packaged to when all sessions connected to it are signed. One or more of: `PADES_CONTAINER` (Pades container).
- Serial signing (`serial_signing`, true/false): Whether to enable serial signing for the document collection.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "documents": [],
    "id": "example",
    "output": {
      "packages": [],
      "serialSigning": []
    },
    "packageTo": [],
    "serialSigning": false
  }
}
```

### Create signing session

Create a new signing session.

**Inputs**

- Title (`title`, text, required): Title.
- Document collection ID (`document_collection_id`, text, required): Document collection id.
- Document ID (`document_id`, text, required): Document id.
- Signing flow (`signing_flow`, text, required): Signing flow. One of: `AUTHENTICATION_BASED` (Authentication based), `PKISIGNING`.
- Identity provider (`identity_provider`, text, required): Configured Signicat identity-provider name.
- Due date (`due_date`, date and time): Due date.

**Outputs**

- `data` (list): Returned value.

**Example output**

```json
{
  "data": []
}
```

### Delete collection

Delete a document collection.

**Inputs**

- Document collection ID (`document_collection_id`, text, required): The unique ID of the document collection.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {}
}
```

### Delete document

Permanently delete a single document and its metadata.

**Inputs**

- Document ID (`document_id`, text, required): The unique ID of the document.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {}
}
```

### Download document

Retrieve the contents of a stored document as base64.

**Inputs**

- Document ID (`document_id`, text, required): Document id.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "content_base64": "example",
    "content_type": "example"
  }
}
```

### Get collection

Retrieve a document collection.

**Inputs**

- Document collection ID (`document_collection_id`, text, required): The unique ID of the document collection.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "documents": [],
    "id": "example",
    "output": {
      "packages": [],
      "serialSigning": []
    },
    "packageTo": [],
    "serialSigning": false
  }
}
```

### Get document metadata

Retrieve all information stored about a single document.

**Inputs**

- Document ID (`document_id`, text, required): The unique ID of the document.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "createdAt": "example",
    "description": "example",
    "documentHash": {
      "hash": "example",
      "hashAlgorithm": "SHA256"
    },
    "documentId": "example",
    "filename": "example",
    "mimeType": "example",
    "title": "example"
  }
}
```

### Get signing session

Retrieve a signing session.

**Inputs**

- Signing session (`session_id`, text, required): The unique ID of the session.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "archive": {
      "archiveTags": [],
      "retentionPeriod": "example",
      "sendPackagingResultToArchive": false,
      "sendSealingResultToArchive": false,
      "sendSignatureResultsToArchive": false
    },
    "documents": [],
    "dueDate": "example",
    "externalReference": "example",
    "forwarding": {
      "childSessionIds": [],
      "flow": "FORWARD_AND_CONTINUE",
      "parentSessionId": "example",
      "senderAddress": "example"
    },
    "id": "example",
    "intentionText": {
      "format": "TEXT",
      "value": "example"
    },
    "lifecycle": {
      "rejectReason": "example",
      "state": "BLOCKED",
      "stateIsFinal": false
    },
    "notifications": [],
    "output": {
      "packages": [],
      "seals": [],
      "signatures": [],
      "userInfo": {
        "dateOfBirth": "example",
        "extra": {},
        "firstName": "example",
        "fullName": "example",
        "lastName": "example",
        "nin": "example",
        "signingTime": "example"
      }
    },
    "packageTo": [],
    "preAuthentication": {
      "enabled": false,
      "identityProviders": []
    },
    "redirectSettings": {
      "cancel": "example",
      "error": "example",
      "reject": "example",
      "success": "example"
    },
    "sealTo": [],
    "signText": "example",
    "signatureUrl": "example",
    "signatureUrlExpiresAt": "example",
    "signatureUrlTTL": 1,
    "signatureUrlTimeToLive": "example",
    "signer": {
      "email": "example",
      "mobile": "example",
      "nationalIdentificationNumber": "example",
      "prefill": [],
      "username": "example",
      "validations": []
    },
    "signingSetup": [],
    "subsequentTo": [],
    "title": "example",
    "ui": {
      "hideWelcomeScreen": false,
      "language": "da",
      "minimalTextMode": false
    },
    "usageTags": []
  }
}
```

### List signing sessions

Retrieve a paginated list of signing sessions.

**Inputs**

- Offset (`offset`, number): Number of rows to skip before returning results. From 0 to 100000. Default: `0`.
- Limit (`limit`, number): Maximum number of rows to return. From 1 to 1000. Default: `100`.
- Sort (`sort`, list): Sorting field. Default value is -createdAt. E.g., +dueDate
- Created date from (`created_date_from`, date and time): Filter signing sessions created on or after this date and time
- Created date to (`created_date_to`, date and time): Filter signing sessions created on or before this date and time
- State (`state`, list): Search field for state. Multiple values allowed. E.g., BLOCKED, READY. See also SessionState enum for possible values.
- Due date from (`due_date_from`, date and time): Filter signing sessions with due date on or after this date and time
- Due date to (`due_date_to`, date and time): Filter signing sessions with due date on or before this date and time
- Session title like (`session_title_like`, text): Filter signing sessions by title using partial text matching (case-insensitive)

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "count": 1,
    "data": [],
    "limit": 1,
    "offset": 1,
    "total": 1
  }
}
```

### Merchant sign

Sign document(s) with merchant certificate.

**Inputs**

- Vendor (`vendor`, text, required): Vendor. One of: `SBID`, `NBID`.
- To be signed documents (`to_be_signed_documents`, list, required): To be signed documents.

**Outputs**

- `data` (list): Returned value.

**Example output**

```json
{
  "data": []
}
```

### Update document metadata

Store optional descriptive data about a stored document.

**Inputs**

- Document ID (`document_id`, text, required): The unique ID of the document.
- Filename (`filename`, text): A name to use if the document is to be stored as a file. Optional metadata about the stored document which the customer can supply.
- Description (`description`, text): A description of the document for display purposes. Optional metadata about the stored document which the customer can supply.
- Title (`title`, text): A title of the document for display purposes. Optional metadata about the stored document which the customer can supply.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "createdAt": "example",
    "description": "example",
    "documentHash": {
      "hash": "example",
      "hashAlgorithm": "SHA256"
    },
    "documentId": "example",
    "filename": "example",
    "mimeType": "example",
    "title": "example"
  }
}
```

### Update signing session

Update an existing signing session.

**Inputs**

- Signing session (`session_id`, text, required): The unique ID of the session.
- Due date (`due_date`, date and time): Due date.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {}
}
```

### Upload document

Upload a PDF or other document from base64 content.

**Inputs**

- Content base64 (`content_base64`, text, required): Base64 file content from an earlier step.
- Content type (`content_type`, text, required): Content type. One of: `application/pdf`, `text/plain`, `application/xml`, `application/octet-stream`.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "createdAt": "example",
    "description": "example",
    "documentHash": {
      "hash": "example",
      "hashAlgorithm": "SHA256"
    },
    "documentId": "example",
    "filename": "example",
    "mimeType": "example",
    "title": "example"
  }
}
```
