Processing Agreement Log Schema

Audit trail of consent-related events recorded against a processing agreement

The Processing Agreement Log schema defines the structure and properties of processing agreement log objects in the Payload API. Processing agreement logs record the individual consent-related events that make up the ESIGN audit trail for a Processing Agreement, such as viewing the terms, agreeing to them, or completing the application.

Processing Agreement Log Object Properties

Complete reference for all properties available in the Processing Agreement Log schema

attrs

object

Custom attributes for extending the resource with additional key-value pairs. Maximum length is 255 characters when serialized.

created_at

string (date-time)Read-only

Timestamp when the resource was created. Automatically set by the system and immutable.

details

string

Additional context recorded for this consent event, if any.

Max length: 255

id

stringRead-only

Unique identifier for the resource. Automatically generated upon creation and cannot be modified. (ID prefix: log)

Pattern: ^log_[A-Za-z0-9]+$

modified_at

string (date-time)Read-only

Timestamp when the resource was last modified. Automatically updated whenever any field changes.

object

enum[string]Read-only

String representing the object type for this resource.

Values: processing_agreement_log

processing_agreement_id ID of ProcessingAgreement

string

ID of the processing agreement this log entry belongs to. (ID prefix: agg)

Pattern: ^agg_[A-Za-z0-9]+$

recorded_at

string (date-time)

UTC timestamp at which this consent event occurred.

type

enum[string]Required

The assent action performed by the signer, recorded on the audit trail.

Values: application-opened, view-processing-agreement, agree-processing-agreement, application-complete

ProcessingAgreement BillingItem