Audit Trails

Get the package audit trail

Retrieves a package’s audit trail as structured JSON - a list of events that occurred during the package’s lifecycle, together with package and document information. The audit trail is available for a package in any status.

Because the audit trail is built from the retained audit log, it can still be retrieved after the package itself has been deleted. In that case the response is reconstructed from the log events alone, so some package and document fields (for example Status, Name and the document page and signed-field counts) may be absent.

To download the signed PDF representation of the audit trail, use GET /packages/{packageId}/audittrail/{culture}.

GET

packages

{packageId}

audittrail

Error

A valid request URL is required to generate request examples

{
  "RequestedOn": "2025-02-27T09:09:46Z",
  "PackageInfo": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "example package",
    "CreatedOn": "2025-01-14T13:24:49Z",
    "Initiator": "hello@world.invalid",
    "Status": "Draft",
    "Documents": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name": "example document",
        "PagesCount": 10,
        "SignedFieldsCount": 4
      }
    ]
  },
  "Events": [
    {
      "Id": "00000000-0000-0000-0000-000000000000",
      "CreatedOn": "2024-08-14T13:24:49Z",
      "IpAddress": "127.1.0.0",
      "Type": "SignActionCompleted",
      "User": "hello@world.invalid",
      "PackageDetail": {
        "ApiSource": "Unknown",
        "TemplateCode": "00001",
        "Documents": [
          {
            "Id": "00000000-0000-0000-0000-000000000000",
            "Name": "example document",
            "PagesCount": 10,
            "SignedFieldsCount": 4
          }
        ]
      },
      "ActionDetail": {
        "ActorId": "00000000-0000-0000-0000-000000000000",
        "PersonId": "00000000-0000-0000-0000-000000000000",
        "EmailAddress": "hello@world.invalid",
        "Documents": [
          {
            "Id": "00000000-0000-0000-0000-000000000000",
            "Name": "example document"
          }
        ],
        "SigningMethods": [
          {
            "Name": "MailOtp:MailOtp",
            "KeyPair": "MyKeyPair"
          }
        ]
      }
    }
  ]
}

[
  {
    "ErrorCode": "Package.NotFound:00000000-0000-0000-0000-000000000000",
    "ErrorMessage": "The package with id '00000000-0000-0000-0000-000000000000' could not be found"
  }
]

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

packageId

string<guid>

required

The target package's unique identifier A package's unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

Response

RequestedOn

string<date-time>

Date of request for this audit trail.

Example:

"2024-08-27T09:09:46Z"

PackageInfo

object

Show child attributes

Events

object[]

A list of events that occured during the lifecycle of the package

Show child attributes

Verify audit trailVerifies whether a package's audit trail is valid, returning a boolean.

Error

A valid request URL is required to generate request examples

{
  "RequestedOn": "2025-02-27T09:09:46Z",
  "PackageInfo": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "example package",
    "CreatedOn": "2025-01-14T13:24:49Z",
    "Initiator": "hello@world.invalid",
    "Status": "Draft",
    "Documents": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name": "example document",
        "PagesCount": 10,
        "SignedFieldsCount": 4
      }
    ]
  },
  "Events": [
    {
      "Id": "00000000-0000-0000-0000-000000000000",
      "CreatedOn": "2024-08-14T13:24:49Z",
      "IpAddress": "127.1.0.0",
      "Type": "SignActionCompleted",
      "User": "hello@world.invalid",
      "PackageDetail": {
        "ApiSource": "Unknown",
        "TemplateCode": "00001",
        "Documents": [
          {
            "Id": "00000000-0000-0000-0000-000000000000",
            "Name": "example document",
            "PagesCount": 10,
            "SignedFieldsCount": 4
          }
        ]
      },
      "ActionDetail": {
        "ActorId": "00000000-0000-0000-0000-000000000000",
        "PersonId": "00000000-0000-0000-0000-000000000000",
        "EmailAddress": "hello@world.invalid",
        "Documents": [
          {
            "Id": "00000000-0000-0000-0000-000000000000",
            "Name": "example document"
          }
        ],
        "SigningMethods": [
          {
            "Name": "MailOtp:MailOtp",
            "KeyPair": "MyKeyPair"
          }
        ]
      }
    }
  ]
}

[
  {
    "ErrorCode": "Package.NotFound:00000000-0000-0000-0000-000000000000",
    "ErrorMessage": "The package with id '00000000-0000-0000-0000-000000000000' could not be found"
  }
]

Product updates

NSEV WebPortal API

Get the package audit trail

Authorizations

Path Parameters

Response