Audit
Last updated
Last updated
The Veratad Audit API is designed to retrieve an audit trail of all transactions processed on a specific day. Please note that data for a particular day is available only on the next calendar day after 7 am EST.
Base URL: https://reporting.veratad.app
To authenticate, you'll need the user
and pass
for the audit trail you want to inquire about.
/api/audit
Fetches an audit trail of transactions for a specified day.
Parameter | Type | Description |
---|---|---|
The response is a JSON object containing a data field, which is an array of transaction objects.
data: An array of transaction objects
id: Transaction ID
timestamp: Timestamp of the transaction
service: Service utilized
reference: Reference code
user: User who initiated the transaction
company: Company name
origin: Origin IP
path: API path
flags: Flags (e.g., test, error)
action: Resulting action
detail: Additional details
issues: Any issues encountered (array)
inputs: Extra input fields
The API could return various errors depending on the situation. Below are the types of errors and their corresponding JSON bodies and HTTP status codes:
Bad Credentials - HTTP Status Code: 401 Unauthorized
Data Not Ready - HTTP Status Code: 404 Not Found
Day Not Available - HTTP Status Code: 404 Not Found
Invalid Date Format - HTTP Status Code: 400 Bad Request
Server Error - HTTP Status Code: 500 Internal Server Error
user
string
Your API username
pass
string
Your API password
day
string
Date (YYYY-MM-DD)