eID Easy

https://docs.eideasy.com
Admin
eID Easy is a comprehensive digital identity platform providing electronic signatures, user...
Tokens:89,661
Snippets:334
Trust Score:9.3
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install Yubico PIV Tool

Source: https://docs.eideasy.com/e-seal/on-premises-eseal.html

Installs the necessary tool for interacting with Yubikey PIV modules.

```bash
sudo apt install yubico-piv-tool
```

--------------------------------

### Authorize Endpoint URL Example

Source: https://docs.eideasy.com/authentication/eideasy-authentication-page-flow.html

Example URL for initiating the user authorization flow.

```text
https://id.eideasy.com/oauth/authorize?client_id=pM...m5&redirect_uri=https://your-site.com/login&response_type=code
```

--------------------------------

### signature.start()

Source: https://docs.eideasy.com/electronic-signatures/api-flow-with-file-hashes-asice.html

Starts the signing process for a prepared document.

```APIDOC
## signature.start()

### Description
Initiates the signing flow. Must be called within a user-triggered event handler to avoid browser popup blocking.

### Parameters
- **clientId** (string) - Required - Client ID from id.eideasy.com.
- **docId** (string) - Required - Document ID from /prepare-files-for-signing.
- **actionType** (string) - Required - Signing method identifier.
- **country** (string) - Required - ISO 3166-1 alpha-2 country code.
- **language** (string) - Optional - ISO 639-1 language code.
- **inputValues.email** (string) - Optional - Pre-fill email.
- **inputValues.username** (string) - Optional - Pre-fill username.
- **inputValues.phone** (string) - Optional - Pre-fill phone number.
- **inputValues.idcode** (string) - Optional - Pre-fill national ID code.

### Request Example
signature.start({
    clientId: 'your_client_id',
    docId: 'doc_id_from_api',
    actionType: 'smart-id-signature',
    country: 'EE',
    language: 'en',
    inputValues: {
        email: 'dummy@dummy.it',
        username: 'testuser',
        phone: '+37212345678',
        idcode: '987654321'
    }
});
```

--------------------------------

### Install Signature JS

Source: https://docs.eideasy.com/electronic-signatures/api-flow-with-file-hashes-asice.html

Install the library using either YARN or NPM package managers.

```bash
yarn add @eid-easy/signature-js
```

```bash
npm install @eid-easy/signature-js
```

--------------------------------

### Example META-INF/manifest.xml for ASIC-E

Source: https://docs.eideasy.com/electronic-signatures/working-with-asice.html

An example of the manifest.xml file used in an ASIC-E container, listing signed files and their media types. Ensure the mimetype entry is the first in the ZIP archive.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<manifest:manifest xmlns:manifest="urn:oasis:names:tc:opendocument:xmlns:manifest:1.0">
  <manifest:file-entry manifest:full-path="/" manifest:media-type="application/vnd.etsi.asic-e+zip"/>
  <manifest:file-entry manifest:full-path="test.txt" manifest:media-type="text/plain"/>
  <manifest:file-entry manifest:full-path="small.pdf" manifest:media-type="application/pdf"/>
</manifest:manifest>
```

--------------------------------

### Start the Signing Process

Source: https://docs.eideasy.com/electronic-signatures/api-flow-with-file-hashes-asice.html

Trigger the signing flow by calling the start method within a user-initiated event handler to prevent browser popup blocking.

```javascript
signature.start({
    clientId: /* your client_id */,
    docId: /* doc_id you received from the /prepare-files-for-signing API call */,
    actionType: 'smart-id-signature',
    country: 'EE',
    language: 'en', // ISO 639-1 two letter language code,
    inputValues: { // optional
        email: 'dummy@dummy.it',
        username: 'testuser',
        phone: '+37212345678',
        idcode: '987654321',
    },
});
```

--------------------------------

### Prepare files for ENVELOPED XAdES signing

Source: https://docs.eideasy.com/electronic-signatures/enveloped-xades-signing.html

Example request body for the POST /api/signatures/prepare-files-for-signing endpoint.

```json
{
  "client_id": "your client id",
  "secret": "your secret",
  "container_type": "xades",
  "files": [
    {
      "fileContent": "base64 encoded file content",
      "fileName": "file name",
      "mimeType": "application/xml"
    }
  ],
  "signature_packaging": "ENVELOPED",
  "noemails": true
}
```

--------------------------------

### Authentication API Response Example

Source: https://docs.eideasy.com/guide/test-user/a-trust.html

Example of the JSON data returned by the API upon successful authentication.

```json
{
  "idcode": "686771022472",
  "lastname": "Xxxöhlinger",
  "firstname": "Xxxhildegard",
  "initials": null,
  "birth_date": null,
  "country": "AT",
  "status": "OK",
  "current_login_method": "at-handy-signatur-login"
}
```

--------------------------------

### Define Environment Configuration

Source: https://docs.eideasy.com/e-seal/on-premises-eseal.html

Example content for the .env-eseal file used to configure the e-seal service.

```text
key_id.card.hsm_implementation=pkcs11
key_id.card.hmac_key=413140d54372f9baf481d4c54e2d5c7bcf28fd6087000280e07976121dd54af2
key_id.card.pkcs11-path=/usr/lib/aarch64-linux-gnu/libykcs11.so 
key_id.card.token-label=YubiKey PIV #13650853
key_id.card.object-id=02
key_id.card.password_url=https://example.com:5555/remote-pin?token=123456
```

--------------------------------

### Basic API Request Configuration

Source: https://docs.eideasy.com/electronic-signatures/api-flow.html

A minimal JSON payload example for initiating a signing request.

```json
  "signature_redirect": "http://eid-sample-app.localhost/show-download-signed-file?file_id=AwX4I1Es5T49H2mr",
  "return_method_configs": true,
  "noemails": true
}
```

--------------------------------

### Starting the Signing Process

Source: https://docs.eideasy.com/electronic-signatures/api-flow-with-file-hashes-pdf.html

Initiate the signing process by calling the `signature.start` method within a user-triggered event handler. This method requires essential parameters like `clientId`, `docId`, `actionType`, and `country`, and can optionally include `language` and `inputValues` for pre-filling form fields.

```APIDOC
## Start Signing

### Description
Initiate the signing process by calling the `signature.start` method within a user-triggered event handler. This method requires essential parameters like `clientId`, `docId`, `actionType`, and `country`, and can optionally include `language` and `inputValues` for pre-filling form fields.

### Method
`signature.start(options)`

### Parameters
#### Request Body
- **clientId** (string) - Required - Get from id.eideasy.com after signing up.
- **docId** (string) - Required - doc_id you receive from the `/prepare-files-for-signing` API call.
- **actionType** (string) - Required - The identifier of the signing method. Available `actionTypes` can be found in the `method_configs` property of the prepare files API response.
- **country** (string) - Required - ISO 3166-1 alpha-2 country code. Available countries per `actionType` can be found in the `method_configs` property of the prepare files API response.
- **language** (string) - Optional - Two letter ISO 639-1 language code.
- **inputValues** (object) - Optional - An object containing values to pre-fill signing form fields.
  - **email** (string) - Optional - Signer's email address.
  - **username** (string) - Optional - Signer's method specific username.
  - **phone** (string) - Optional - Signer's method specific phone number.
  - **idcode** (string) - Optional - Signer's national id code.

### Request Example
```javascript
signature.start({
    clientId: 'YOUR_CLIENT_ID',
    docId: 'YOUR_DOC_ID',
    actionType: 'smart-id-signature',
    country: 'EE',
    language: 'en',
    inputValues: {
        email: 'dummy@dummy.it',
        username: 'testuser',
        phone: '+37212345678',
        idcode: '987654321'
    }
});
```
```

--------------------------------

### Minimal Cloud-Init Configuration for Raspberry Pi

Source: https://docs.eideasy.com/e-seal/on-premises-eseal.html

This Cloud-Init configuration sets up a default user, adds an SSH key for remote access, and installs Docker. Ensure '#cloud-config' is the first line.

```yaml
#cloud-config

## Create default user ubuntu with default password Ubuntu that needs to be changed during first login
chpasswd:
  list:
    - ubuntu:ubuntu

## Add this SSH key for logging in to the Raspberry
ssh_authorized_keys:
  - ssh-rsa AAAAB3Nz....FzDTkv6J my-admin-computer

## Install docker on boot
packages:
  - docker.io

```

--------------------------------

### Example Signed File Download Response

Source: https://docs.eideasy.com/electronic-signatures/eideasy-signing-page-flow.html

This is an example of a successful response when downloading a signed file. The 'signed_file_contents' field contains the file in base64 encoding.

```json
{
  "status": "OK",
  "signed_file_contents": "UEsDBBQAAAgAAHI6z06KIflFHwAA",
  "signer_id": "34501234215",
  "filename": "signed_doc.pdf"
}
```

--------------------------------

### Example Signed File Response

Source: https://docs.eideasy.com/electronic-signatures/api-flow-with-file-hashes-asice.html

This is an example of a successful response when fetching a signed file. The `signed_file_contents` field contains the signature in base64 encoding. If the status is not 'OK', the signature is not verified.

```json
{
   "status": "OK",
   "signed_file_contents": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIH...",
   "filename": "signature.xml",
   "signer_idcode": "30303039914",
   "signer_country": "EE",
   "signer_firstname": "QUALIFIED OK1",
   "signer_lastname": "TESTNUMBER",
   "signing_method": "smart-id-signature"
}
```

--------------------------------

### Prepare File for Signing Response

Source: https://docs.eideasy.com/electronic-signatures/api-flow-with-file-hashes-asice.html

The API returns a doc_id and a list of available signing methods for the session.

```json
{
   "status": "OK",
   "doc_id": "QLcJD03LUP0S7DUeTGNobQdsiJGfzqRnULrGE0iV",
   "expires_at": "2025-05-17T05:06:00Z",
   "method_configs": [
      {
         "action_type": "mid-signature",
         "supported_countries": [
            "EE"
         ]
      },
      {
         "action_type": "smart-id-signature",
         "supported_countries": [
            "EE",
            "LV",
            "LT"
         ]
      },
      ...
   ]
}
```

--------------------------------

### Navigate to the service directory

Source: https://docs.eideasy.com/electronic-signatures/api-flow-with-file-hashes-pdf.html

Change the current working directory to the service folder.

```bash
cd eideasy-external-pades-digital-signatures/
```

--------------------------------

### Signing Started Webhook POST Body

Source: https://docs.eideasy.com/electronic-signatures/signature-webhooks.html

This JSON object represents the payload sent when the signing process has started. It contains basic information about the document and the signing action type.

```json
{
   "type": "signing_started",
   "doc_id": "GGWshqRk8MgwKRBZtJNfLs4cowQVBmEgUba6rCF0",
   "action_type": "certsign-webapi-qes-signature"
}
```

--------------------------------

### PDF File Structure Example

Source: https://docs.eideasy.com/electronic-signatures/asice-batch-signing.html

This is an example of a simple PDF file structure. It outlines the basic objects and streams that constitute a PDF document, including catalog, pages, resources, and content streams. This is for informational purposes to understand the underlying format.

```pdf
JVBERi0xLjMNCiXi48/TDQoNCjEgMCBvYmoNCjw8DQovVHlwZSAvQ2F0YWxvZw0KL091dGxpbmVzIDIgMCBSDQovUGFnZXMgMyAwIFINCj4+DQplbmRvYmoNCg0KMiAwIG9iag0KPDwNCi9UeXBlIC9PdXRsaW5lcw0KL0NvdW50IDANCj4+DQplbmRvYmoNCg0KMyAwIG9iag0KPDwNCi9UeXBlIC9QYWdlcw0KL0NvdW50IDINCi9LaWRzIFsgNCAwIFIgNiAwIFIgXSANCj4+DQplbmRvYmoNCg0KNCAwIG9iag0KPDwNCi9UeXBlIC9QYWdlDQovUGFyZW50IDMgMCBSDQovUmVzb3VyY2VzIDw8DQovRm9udCA8PA0KL0YxIDkgMCBSIA0KPj4NCi9Qcm9jU2V0IDggMCBSDQo+Pg0KL01lZGlhQm94IFswIDAgNjEyLjAwMDAgNzkyLjAwMDBdDQovQ29udGVudHMgNSAwIFINCj4+DQplbmRvYmoNCg0KNSAwIG9iag0KPDwgL0xlbmd0aCAxMDc0ID4+DQpzdHJlYW0NCjIgSg0KQlQNCjAgMCAwIHJnDQovRjEgMDAyNyBUZg0KNTcuMzc1MCA3MjIuMjgwMCBUZA0KKCBBIFNpbXBsZSBQREYgRmlsZSApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY4OC42MDgwIFRkDQooIFRoaXMgaXMgYSBzbWFsbCBkZW1vbnN0cmF0aW9uIC5wZGYgZmlsZSAtICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjY0LjcwNDAgVGQNCigganVzdCBmb3IgdXNlIGluIHRoZSBWaXJ0dWFsIE1lY2hhbmljcyB0dXRvcmlhbHMuIE1vcmUgdGV4dC4gQW5kIG1vcmUgKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NTIuNzUyMCBUZA0KKCB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDYyOC44NDgwIFRkDQooIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjE2Ljg5NjAgVGQNCiggdGV4dC4gQW5kIG1vcmUgdGV4dC4gQm9yaW5nLCB6enp6ei4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjA0Ljk0NDAgVGQNCiggbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDU5Mi45OTIwIFRkDQooIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNTU3LjEzNjAgVGQNCiggQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA1NDUuMTg0MCBUZA0KKCBUaGlzIGlzIHRoZSBsYXN0IHBhZ2UuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCkgVGoNCkVUDQplbmRzdHJlYW0NCmVuZG9iag0KDQo2IDAgb2JqDQo8PA0KL1R5cGUgL1BhZ2UNCi9QYXJlbnQgMyAwIFINCi9SZXNvdXJjZXMgPDwNCi9Gb250IDw8DQovRjEgOSAwIFINCj4+DQovUHJvY1NldCA4IDAgUg0KPj4NCi9NZWRpYUJveCBbMCAwIDYxMi4wMDAwIDc5Mi4wMDAwXQ0KL0NvbnRlbnRzIDcgMCBSDQo+Pg0KZW5kb2JqDQoNCjcgMCBvYmoNCjw8IC9MZW5ndGggNjc2ID4+DQpzdHJlYW0NCjIgSg0KQlQNCjAgMCAwIHJnDQovRjEgMDAyNyBUZg0KNTcuMzc1MCA3MjIuMjgwMCBUZA0KKCBTaW1wbGUgUERGIEZpbGUgMiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY4OC42MDgwIFRkDQooIC4uLmNvbnRpbnVlZCBmcm9tIHBhZ2UgMS4gWWV0IG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NzYuNjU2MCBUZA0KKCBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY2NC43MDQwIFRkDQooIHRleHQuIE9oLCBob3cgYm9yaW5nIHR5cGluZyB0aGlzIHN0dWZmLiBCdXQgbm90IGFzIGJvcmluZyBhcyB3YXRjaGluZyApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY1Mi43NTIwIFRkDQooIHBhaW50IGRyeS4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NDAuODAwMCBUZA0KKCBCb3JpbmcuICBNb3JlLCBhIGxpdHRsZSBtb3JlIHRleHQuIFRoZSBlbmQsIGFuZCBqdXN0IGFzIHdlbGwuICkgVGoNCkVUDQplbmRzdHJlYW0NCmVuZG9iag0KDQo4IDAgb2JqDQpbL1BERiAvVGV4dF0NCmVuZG9iag0KDQo5IDAgb2JqDQo8PA0KL1R5cGUgL0ZvbnQNCi9TdWJ0eXBlIC9UeXBlMQ0KL05hbWUgL0YxDQovQmFzZUZvbnQgL0hlbHZldGljYQ0KL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcNCj4+DQplbmRvYmoNCg0KMTAgMCBvYmoNCjw8DQovQ3JlYXRvciAoUmF2ZSBcKGh0dHA6Ly93d3cubmV2cm9uYS5jb20vcmF2ZSl9DQovUHJvZHVjZXIgKE5ldnJvbmEgRGVzaWducykNCi9DcmVhdGlvbkRhdGUgKEQ6MjAwNjAzMDEgMDcyODI2KQ0KPj4NCmVuZG9iag0KDQp4cmVmDQowIDExDQowMDAwMDAwMDAwIDY1NTM1IGYNCjAwMDAwMDAwMTkgMDAwMDAgYg0KMDAwMDAwMDExOSAwMDAwMCBuDQowMDAwMDAwMTQ3IDAwMDAwIG4NCjAwMDAwMDAyMjIgMDAwMDAgbg0KMDAwMDAwMDM5MCAwMDAwMCBuDQowMDAwMDAxNTIyIDAwMDAwIG4NCjAwMDAwMDE2OTAgMDAwMDAgbg0KMDAwMDAwMjQyMyAwMDAwMCBuDQowMDAwMDAyNDU2IDAwMDAwIG4NCjAwMDAwMDI1NzQgMDAwMDAgbg0KDQp0cmFpbGVyDQo8PA0KL1NpemUgMTENCi9Sb290IDEgMCBSDQovSW5mbyAxMCAwIFINCj4+DQoNCnN0YXJ0eHJlZg0KMjcxNA0KJSVFT0Y=
```

--------------------------------

### Access Token Response

Source: https://docs.eideasy.com/authentication/eideasy-authentication-page-flow.html

Example JSON response containing the access token.

```json
{
  "access_token":"yF...zc",
  "token_type":"Bearer",
  "expires_in":3600
}
```

--------------------------------

### Examine Yubikey Token Details

Source: https://docs.eideasy.com/e-seal/on-premises-eseal.html

Lists available PKCS#11 slots and token information using the Yubikey library.

```bash
$ pkcs11-tool --module /usr/lib/libykcs11.so -L
Available slots:
Slot 0 (0x0): Yubico YubiKey OTP+FIDO+CCID 01 00
  token label        : YubiKey PIV #13650870
  token manufacturer : Yubico (www.yubico.com)
  token model        : YubiKey YK5
  token flags        : login required, rng, token initialized, PIN initialized
  hardware version   : 1.0
  firmware version   : 5.24
  serial num         : 13650870
  pin min/max        : 6/48
```

--------------------------------

### POST /api/signatures/prepare-files-for-signing

Source: https://docs.eideasy.com/electronic-signatures/enveloped-xades-signing.html

Prepares XML files for ENVELOPED XAdES signature packaging.

```APIDOC
## POST /api/signatures/prepare-files-for-signing

### Description
Prepares XML files for signing using the ENVELOPED XAdES packaging method, which embeds the signature within the original XML file.

### Method
POST

### Endpoint
/api/signatures/prepare-files-for-signing

### Parameters
#### Request Body
- **client_id** (string) - Required - Your client ID
- **secret** (string) - Required - Your secret
- **container_type** (string) - Required - Must be set to "xades"
- **files** (array) - Required - Array of files to be signed
  - **fileContent** (string) - Required - Base64 encoded file content
  - **fileName** (string) - Required - File name
  - **mimeType** (string) - Required - Must be set to "application/xml"
- **signature_packaging** (string) - Required - Must be set to "ENVELOPED"
- **noemails** (boolean) - Optional - Set to true if notification emails are not needed

### Request Example
{
  "client_id": "your client id",
  "secret": "your secret",
  "container_type": "xades",
  "files": [
    {
      "fileContent": "base64 encoded file content",
      "fileName": "file name",
      "mimeType": "application/xml"
    }
  ],
  "signature_packaging": "ENVELOPED",
  "noemails": true
}
```

--------------------------------

### POST Signing Events Webhook

Source: https://docs.eideasy.com/electronic-signatures/signature-webhooks.html

Triggered when the signing process starts or completes.

```APIDOC
## POST Signing Events Webhook

### Description
This webhook is triggered when the signing process starts or completes.

### Method
POST

### Request Body
- **type** (string) - Event type: 'signing_started' or 'signing_completed'.
- **doc_id** (string) - The ID of the document.
- **action_type** (string) - The type of signing action.
- **data** (object) - Optional details provided upon completion.

### Request Example
{
   "type": "signing_completed",
   "doc_id": "GGWshqRk8MgwKRBZtJNfLs4cowQVBmEgUba6rCF0",
   "action_type": "certsign-webapi-qes-signature",
   "data": {
      "doc_id": "GGWshqRk8MgwKRBZtJNfLs4cowQVBmEgUba6rCF0",
      "signer_id": "PNORO-VR14",
      "notification_state": {"data": "state"},
      "template_id": null,
      "signing_time": 1749706935432,
      "signing_method": "certsign-webapi-qes-signature",
      "signature_level": "qualified",
      "signer_data": {
         "name": "Taavi Olen",
         "id_code": "VR14",
         "country": "RO",
         "otp_sms": "+6666666666"
      }
   }
}
```
Tokens:
Raw