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 NameTypeDescription
itemsarrayList of records describing actions on journey.
has_more_pagesbooleanIndicates whether there are more pages to fetch
next_page_tokenstring|nullA token to fetch the next page of results. Null if there are no additional pages.
page_sizeintegerThe maximum number of items returned per page.
total_countintegerThe total audit log items count available for the specified journey.

Items elements fields

Field NameTypeDescription
actionstringThe 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
emailstring|nullThe email of the user who performed the action. Null if the action was performed by a server API key.
principal_idstringThe unique identifier of the principal (user or API key) who performed the action.
principal_typeenumThe type of principal. Possible values are:

- user
- server_api_key
- client_api_key
resource_idstringThe ID of the journey being accessed or modified.
resource_tenent_idstringThe tenant ID associated with the resource.
resource_typeenumThe type of resource:

- journey
statusenumThe outcome of the action. Possible values are:

- Succeeded
- Failed
timestampstringThe ISO 8601 timestamp of when the action occurred.
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!