Process tracking parameters

Overview

The Loan Self-Service platform captures tracking parameters for each loan process. These parameters include marketing attribution data (such as UTM parameters and affiliate identifiers) and session metadata, which identify the source through which a customer enters Self-Service. This information allows you to identify which partner or campaign generated a process, measure channel performance, and support attribution and partner reconciliation.

You can retrieve attribution data for a process through a secure API for use in analytics and reporting.

How it works

The system automatically stores tracking parameters when a user opens an existing process or creates a new one. The following diagram shows the tracking process:

When a user clicks a marketing link (for example, from an ad or partner site) and is redirected to Self-Service, the URL may include tracking parameters such as affiliate identifiers, UTM parameters, and session data.
These parameters are stored in the browser’s local storage and are assigned a timestamp (occurredOn) when captured. They remain valid for up to 30 days.
There are two scenarios:

a. If the user opens an existing process or creates a new one within 30 days of capture, Self-Service persists the captured tracking parameters as records associated with the process, each including a timestamp (occurredOn). You can now retrieve tracking parameters using API.
Note
- Tracking parameters are attached only to the first process that the user opens or creates after entering Self-Service via a tracked link. The parameters are not automatically attached to other processes in the same session.
- If a user accesses Self-Service multiple times through different marketing links, each set of captured parameters is stored as a separate record. This creates an attribution history for the process, ordered by capture time.
b. If the user takes no action within this period, the tracking parameters expire and are no longer used.

Retrieve tracking history using API

Prerequisites

You must have valid API credentials for authentication. Contact your Customer Service representative for further assistance.

Request

To retrieve the attribution history for a loan process, make a GET request to the https://api.{tenant-label}.direct.{region}.lending.akkuro.io/processes/{reference-id}/tracking-params endpoint. For a full schema, see Process Tracking Params API.

Base URL variables:

{tenant-label}: Your tenant subdomain
{region}: Your deployment region

Path parameters:

Parameter	Type	Description	Required
`reference-id`	String	Unique identifier of a process in the loan self-service portal.	Yes

Request example:

curl --location --request GET 'https://api.{tenant-label}.direct.eu.lending.akkuro.io/processes/aac3a992-96b9-4e95-a623-17be904bff1c/tracking-params' \
  --header 'Accept: application/json;api-version=2026.1.0' \
  --header 'Authorization: Bearer {your_JWT_token}'

Response

The API returns a paginated history of tracking entries for the specified process. Entries are sorted by capture time. Each entry includes only the tracking fields available at capture time, plus occurredOn. See the API schema for details.

Response example:

{
  "items": [
    {
      "affiliateId": "aff_12345",
      "utmSource": "google",
      "utmMedium": "cpc",
      "utmCampaign": "winter_loan_push",
      "sessionId": "sess_a1b2c3d4",
      "occurredOn": "2025-12-19T08:22:05Z"
    },
    {
      "affiliateId": "aff_12345",
      "occurredOn": "2025-12-19T09:01:43Z"
    },
    {
      "utmSource": "newsletter",
      "utmMedium": "email",
      "utmCampaign": "december_retarget",
      "sessionId": "sess_ef567890",
      "occurredOn": "2025-12-19T10:15:11Z"
    },
    {
      "affiliateId": "aff_67890",
      "utmSource": "facebook",
      "utmMedium": "paidSocial",
      "utmCampaign": "remarketing_q4",
      "sessionId": "sess_7777aaaa",
      "occurredOn": "2025-12-19T10:15:11Z"
    }
  ]
  ...
}

The response contains the following parameters:

Parameter	Description
`affiliateId`	Affiliate identifier used for partner attribution.
`utmSource`	Where the traffic came from, such as Google, a newsletter, or Facebook.
`utmMedium`	Marketing medium, such as `cpc`, `email`, `social`.
`utmCampaign`	Campaign name or promotion identifier.
`sessionId`	A unique identifier captured from the URL query string that represents a browsing session.
`occurredOn`	Timestamp indicating when the tracking event occurred (UTC).

Overview​

How it works​

Retrieve tracking history using API​

Prerequisites​

Request​

Response​