API Basics

This guide introduces the core concepts required to integrate with the Trudenty Consumer Trust Index (CTI) API. It explains how requests are authenticated, how responses are structured, and the conventions used throughout the API.

Understanding these fundamentals will help you build reliable integrations and make effective use of the available API endpoints.

API Overview

The Trudenty Consumer Trust Index API is a RESTful API that enables authorized partner applications to retrieve Consumer Trust Index (CTI) data using a unique consumer_id.

All communication with the API takes place over HTTPS using JSON request and response payloads.

The API currently provides endpoints for:

• Verifying API availability
• Retrieving the latest Consumer Trust Index
• Retrieving Consumer Trust Index history

Authentication

The Consumer Trust Index API uses client credential authentication.

All endpoints, except the Health Check endpoint, require valid partner credentials supplied in the request headers.

Credentials are issued during the Trudenty partner onboarding process.

Required Headers

Both headers must be present and must be non-empty strings.

API Versioning

The Consumer Trust Index API uses URL-based versioning.

The current API version is:

v1

Example:

GET /v1/consumer-trust-index?consumer_id=CUST1234

Future API versions will be introduced using a new version prefix while maintaining backward compatibility where possible.

Request Correlation

Every API request is assigned a unique request identifier.

The identifier is returned in the response header:

X-Request-ID

Example:

X-Request-ID: req_a1b2c3d4-e5f6-7890-abcd-ef1234567890

Most responses also include the same value within the response body as the request_id field.

Always include the request identifier when contacting Trudenty Support.

Response Format

The API returns responses in JSON format.

A successful response typically includes:

• Request status
• Request identifier
• Requested resource data

Example:

{
  "status": "success",
  "request_id": "req_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "data": {
    ...
  }
}

Refer to the API Reference for endpoint-specific response schemas.

What's Next