Get Journey Audit Logs

Description

The Get Journey Audit Logs API provides a comprehensive record of all key actions taken on a specific onboarding journey. It captures who accessed the journey, who reviewed it, when it started, and other critical events, ensuring transparency, compliance, and security in the identity verification process.

Description of Response Fields

Field Name	Type	Description
`items`	`array`	List of records describing actions on journey.
`has_more_pages`	`boolean`	Indicates whether there are more pages to fetch
`next_page_token`	`string\	null`
`page_size`	`integer`	The maximum number of items returned per page.
`total_count`	`integer`	The total audit log items count available for the specified journey.

`Items` elements fields

Field Name	Type	Description
`action`	`string`	The action performed possible values are: `get_journey` `search_journeys` `get_applicant_duplicates` `manual_review` `get_journey_pdf` `perform_aml_check` `archive_journey` `process_step` `start_journey` `pause_journey` `complete_custom_steps` `complete_user_steps` `resume_journey`
`email`	`string\\|null`	The email of the user who performed the action. Null if the action was performed by a server API key.
`principal_id`	`string`	The unique identifier of the principal (user or API key) who performed the action.
`principal_type`	`enum`	The type of principal. Possible values are: `user` `server_api_key` `client_api_key`
`resource_id`	`string`	The ID of the journey being accessed or modified.
`resource_tenent_id`	`string`	The tenant ID associated with the resource.
`resource_type`	`enum`	The type of resource: `journey`
`status`	`enum`	The outcome of the action. Possible values are: `Succeeded` `Failed`
`timestamp`	`string`	The ISO 8601 timestamp of when the action occurred.

Description

Description of Response Fields

Items elements fields

`Items` elements fields