Skip to content

Web Services / V6 Analytic API

Prerequisites

Prerequisites for the use of analytic web services

To obtain authentication access to the Trust and Sign web services, you must complete the account creation process with Namirial.

In order to use the APIs exposed by Trust and Sign, a login/password pair is required. This information is provided in the document_product.pdf file sent by Namirial when a product is created. The login corresponds to the public ID and the password to the secret key.

Here is the URL to query analytic API:

https://api.ekeynox.net/contract/v6/integration/analytic/events

The following chapters describe the JSON API as it is currently available.

As part of ongoing product improvements, additional fields that are not yet documented may be added to the responses. We therefore recommend designing your integration to be sufficiently flexible so that it does not reject payloads containing extra attributes.

IMPORTANT

The name of the keys is case sensitive. All parameters marked with (*) are mandatory, the others are facultative.

Authentication

Basic authentication is used here, it follows the RFC1945 standard. An HTTP header named AUTHORIZATION must be added to requests. This is of the form :

AUTHORIZATION = Basic base64(login:password)

The following code snippet can be used in Java to generate this header:

String header = "Basic " + Base64.getEncoder().encodeToString((login + ":" + password).getBytes(StandardCharsets.UTF_8));

For example, for a login "john123456" and a password "azerty" the following header is obtained:

AUTHORIZATION = Basic am9objEyMzQ1NjphemVydHk=

Retrieve events of all client files

Over a given period

This endpoint allows to retrieve the events associated with all client files, over or still in progress.

Endpoint

GET /v6/integration/analytic/events

Request parameters

  • startDate (*): start date and time of the search period. Only events whose event date is greater than or equal to this value will be taken into account. The expected format is ISO 8601.

  • endDate (*): end date and time of the search period. Only events whose event date is less than or equal to this value will be taken into account. The expected format is ISO 8601.

  • page: the results page to retrieve. Each page contains 1,000 events. If this parameter is not provided, page 1 is returned.

Response

The response is a JSON object containing a list of events. Events are grouped by client file and sorted from most recent to oldest.

See API response

Example

/v6/integration/analytic/events?startDate=2025-08-03T23:50:00.000Z&endDate=2025-08-05T00:00:00.000Z&page=1

For a specific client file

This request allows retrieving all events associated with a client file, completed or in progress.

Endpoint

GET /v6/integration/analytic/{clientFileUuid}/events

Request parameters

  • startDate: start date and time of the search period. Only events whose event date is greater than or equal to this value will be taken into account. The expected format is ISO 8601.

  • endDate: end date and time of the search period. Only events whose event date is less than or equal to this value will be taken into account. The expected format is ISO 8601.

  • page: the results page to retrieve. Each page contains 1,000 events. If this parameter is not provided, page 1 is returned.

Examples

GET /v6/integration/analytic/0197fa0b-5714-74cd-9f23-623b846fb8af/events
GET /v6/integration/analytic/0197fa0b-5714-74cd-9f23-623b846fb8af/events?page=2
GET /v6/integration/analytic/0197fa0b-5714-74cd-9f23-623b846fb8af/events?startDate=2025-08-03T23:50:00.000Z&page=2
GET /v6/integration/analytic/0197fa0b-5714-74cd-9f23-623b846fb8af/events?startDate=2025-08-03T23:50:00.000Z&endDate=2025-09-03T23:50:00.000Z&page=3

Response

See API response

Retrieve events of closed client files only

Over a given period

This endpoint allows you to retrieve the events associated with closed client files: accepted or rejected.

Endpoint

GET /v6/integration/analytic/closed

Request parameters

  • startDate (*): start date and time of the search period. Only events whose closing date is greater than or equal to this value will be taken into account. The expected format is ISO 8601.

  • endDate (*): end date and time of the search period. Only events whose closing date is less than or equal to this value will be taken into account. The expected format is ISO 8601.

  • page: the results page to retrieve. Each page contains 1,000 events. If this parameter is not provided, page 1 is returned.

/v6/integration/analytic/closed?startDate=2025-08-03T23:50:00.000Z&endDate=2025-08-05T00:00:00.000Z&page=1

Response

The response is a JSON object containing a list of events. Events are grouped by client file and sorted from most recent to oldest.

See API response

For a specific closed client file

This request allows retrieving all events associated with a closed client file (accepted or rejected).

Endpoint

GET /v6/integration/analytic/{clientFileUuid}/closed

Request parameters

  • startDate: start date and time of the search period. Only events whose closing date is greater than or equal to this value will be taken into account. The expected format is ISO 8601.

  • endDate: end date and time of the search period. Only events whose closing date is less than or equal to this value will be taken into account. The expected format is ISO 8601.

  • page: the results page to retrieve. Each page contains 1,000 events. If this parameter is not provided, page 1 is returned.

GET /v6/integration/analytic/{clientFileUuid}/closed?startDate=2025-08-03T23:50:00.000Z&page=3

Response

See API response

Examples

GET /v6/integration/analytic/0197fa0b-5714-74cd-9f23-623b846fb8af/closed
GET /v6/integration/analytic/0197fa0b-5714-74cd-9f23-623b846fb8af/closed?page=2
GET /v6/integration/analytic/0197fa0b-5714-74cd-9f23-623b846fb8af/closed?startDate=2025-08-03T23:50:00.000Z&page=2
GET /v6/integration/analytic/0197fa0b-5714-74cd-9f23-623b846fb8af/closed?startDate=2025-08-03T23:50:00.000Z&endDate=2025-09-03T23:50:00.000Z&page=3

API response

The JSON contains the following keys:

  • eventId: the event UUID (different from the Trust and Sign UUID)
  • eventTypeKey: the event type for example "CREATION" or "SIGNATURE"
  • eventTimestamp: the event date in timestamp format (milliseconds)
  • eventStatus: the event status, possible values are OK | KO (Optional)
  • contextId: the client file UUID in Trust and Sign
  • participantKey: the participant identifier in Trust and Sign
  • rejectionReason: the rejection reason (only for events with type REJECTION)
  • signatureLevelKey: the signature level (only for events with type SIGNATURE)
  • workflowKey: the workflow UUID in Trust and Sign
  • workflowVersion: the workflow version in Trust and Sign
  • workflowLabel: the workflow name in Trust and Sign
  • productUuid: the product UUID in Trust and Sign
  • productLabel: the product label in Trust and Sign
  • companyLabel: the company label in Trust and Sign
  • externalId: the external identifier provided in the Trust and Sign client file, it is used by the customer to have a reference for their system (Optional)
  • source: the source identifier of the client
  • provider: the service provider of the event, can be archiving, signature, or internal service
[
    {
        "eventId": "01983cdb-f945-7143-936a-6555dee79cac",
        "eventTypeKey": "VIDEO_IDENTIFICATION_PROCESSED",
        "eventTimestamp": 1752255975000,
        "eventStatus": "KO",
        "contextId": "0197fa0b-4bc7-7ecd-9a9b-d3e48fbceb2e",
        "participantKey": "0197fa27-bcba-76e6-9035-efe45013fe05",
        "workflowKey": "0197fa0b-4b09-7005-8201-ea6227ddaf67",
        "workflowVersion": "1",
        "workflowLabel": "facematch-identity",
        "productUuid": "0197fa09-1d0e-7eed-968f-0fb7ebb5506c",
        "productLabel": "Test product",
        "companyLabel": "Company test",
        "externalId": "external_id_123456",
        "source": "Chrome_13138#Linux",
        "provider": "ek_prevent_video"
    },
    {
        "eventId": "0197fa0b-4be0-7120-a88f-4ddf2a76e3f2",
        "eventTypeKey": "CREATION",
        "eventTimestamp": 1752253933000,
        "contextId": "0197fa0b-4bc7-7ecd-9a9b-d3e48fbceb2e",
        "workflowKey": "0197fa0b-4b09-7005-8201-ea6227ddaf67",
        "workflowVersion": "1",
        "workflowLabel": "facematch-identity",
        "productUuid": "0197fa09-1d0e-7eed-968f-0fb7ebb5506c",
        "productLabel": "Test product",
        "companyLabel": "Company test",
        "externalId": "external_id_123456"
    },
    {
        "eventId": "0199f28d-5aa6-7ab3-a593-f649362b0280",
        "eventTypeKey": "VIDEO_IDENTIFICATION_REQUESTED",
        "eventTimestamp": 1752250974000,
        "contextId": "0197fa0b-4bc7-7ecd-9a9b-d3e48fbceb2e",
        "participantKey": "0199f28d-0474-7b10-b88d-d377646bcd91",
        "workflowKey": "0197fa0b-4b09-7005-8201-ea6227ddaf67",
        "workflowVersion": "1",
        "workflowLabel": "facematch-identity",
        "productUuid": "0197fa09-1d0e-7eed-968f-0fb7ebb5506c",
        "productLabel": "Test product",
        "companyLabel": "Company test",
        "externalId": "external_id_123456",
        "source": "Chrome_14141#Linux",
        "provider": "ek_prevent_video"
    },
    {
        "eventId": "0197fa0b-5009-776d-b19e-cbc641a27bf2",
        "eventTypeKey": "UPDATE",
        "eventTimestamp": 1752253934000,
        "contextId": "0197fa0b-4e83-79d3-81e8-856d1149e8f0",
        "workflowKey": "0197fa0b-4b09-7005-8201-ea6227ddaf67",
        "workflowVersion": "2",
        "workflowLabel": "facematch-identity",
        "productUuid": "0197fa09-1d0e-7eed-968f-0fb7ebb5506c",
        "productLabel": "Test product",
        "companyLabel": "Company test",
        "externalId": "external_id_789012"
    },
    {
        "eventId": "0197fa0b-4e86-78b7-8e52-1ae3a589c7c7",
        "eventTypeKey": "CREATION",
        "eventTimestamp": 1752253934000,
        "contextId": "0197fa0b-4e83-79d3-81e8-856d1149e8f0",
        "workflowKey": "0197fa0b-4b09-7005-8201-ea6227ddaf67",
        "workflowVersion": "2",
        "workflowLabel": "facematch-identity",
        "productUuid": "0197fa09-1d0e-7eed-968f-0fb7ebb5506c",
        "productLabel": "Test product",
        "companyLabel": "Company test",
        "externalId": "external_id_789012"
    },
    {
        "eventId": "0197fa0b-54c0-7a0f-8dbb-ca91df5ef684",
        "eventTypeKey": "FINALIZATION",
        "eventTimestamp": 1752253936000,
        "contextId": "0197fa0b-52b9-76f7-8405-98091fde7401",
        "workflowKey": "0197fa0b-529a-7781-a133-e83d79249bbc",
        "workflowVersion": "1",
        "workflowLabel": "facematch-identity-validation",
        "productUuid": "0197fa09-1d0e-7eed-968f-0fb7ebb5506c",
        "productLabel": "Test product",
        "companyLabel": "Company test"
    },
    {
        "eventId": "0197fa0b-551b-73af-9739-87519a216086",
        "eventTypeKey": "REJECTION",
        "eventTimestamp": 1752253936000,
        "contextId": "0197fa0b-52b9-76f7-8405-98091fde7401",
        "rejectionReason": "FILE_REJECTED_AFTER_VERIFICATION",
        "workflowKey": "0197fa0b-529a-7781-a133-e83d79249bbc",
        "workflowVersion": "1",
        "workflowLabel": "facematch-identity-validation",
        "productUuid": "0197fa09-1d0e-7eed-968f-0fb7ebb5506c",
        "productLabel": "Test product",
        "companyLabel": "Company test"
    },
    {
        "eventId": "0197fa0b-54bc-7695-8335-a83e256979e3",
        "eventTypeKey": "PARTICIPANT_COMPLETION",
        "eventTimestamp": 1752253936000,
        "contextId": "0197fa0b-52b9-76f7-8405-98091fde7401",
        "participantKey": "0197fa0b-52bb-7c75-ac89-562a04b5f601",
        "workflowKey": "0197fa0b-529a-7781-a133-e83d79249bbc",
        "workflowVersion": "1",
        "workflowLabel": "facematch-identity-validation",
        "productUuid": "0197fa09-1d0e-7eed-968f-0fb7ebb5506c",
        "productLabel": "Test product",
        "companyLabel": "Company test",
        "source": "Chrome_5757#Linux"
    }
]