Postman & cURL Examples

This guide walks you through creating a Postman collection for the Trudenty Consumer Trust Index (CTI) API and provides ready-to-use cURL examples for testing each endpoint.

💡
Explore the API
Trudenty provides an interactive Swagger (OpenAPI) API Reference where you can explore endpoints, review request and response schemas, and test API operations directly from your browser.
If you prefer using Postman for development and testing, follow the steps below to manually create a Postman collection using the same API endpoints and authentication details.

Prerequisites

Before you begin, ensure you have the following:

A Postman account or the Postman Desktop application
Your assigned Client ID
Your assigned Client Secret
The Trudenty API Base URL

Variable	Example
Base URL	`https://partners.trudenty.com`
Client ID	`YOUR_CLIENT_ID`
Client Secret	`YOUR_CLIENT_SECRET`

Step 1 - Create a New Collection

Open Postman.
Click New.
Select Collection.
Enter the collection name.

Example:

Trudenty Consumer Trust Index APIs

Click Create.

Step 2 - Configure Collection Variables

Open the newly created collection and navigate to the Variables tab.

Create the following variables.

Variable	Value
`BASE_URL`	`https://partners.trudenty.com`
`X-CLIENT-ID`	`YOUR_CLIENT_ID`
`X-CLIENT-SECRET`	`YOUR_CLIENT_SECRET`

Click Save.

Step 3 - Create API Requests

You can now create requests inside the collection.

Health Check API

The Health endpoint allows you to verify that the API service is available.

Request Configuration

Property	Value
Name	Health
Method	GET
URL	`{{BASE_URL}}/v1/health`

Postman Request

GET {{BASE_URL}}/v1/health

Headers

Header	Value
Accept	`application/json`

cURL

curl --request GET \
  --url https://partners.trudenty.com/v1/health \
  --header 'Accept: application/json'

The Health endpoint does not require authentication.

Consumer Trust Index API

Retrieves the latest Consumer Trust Index (CTI) for a specified consumer.

Request Configuration

Property	Value
Name	Get Consumer Trust Index
Method	GET
URL	`{{BASE_URL}}/v1/consumer-trust-index`

Postman Request

GET {{BASE_URL}}/v1/consumer-trust-index?consumer_id=CUST1234&consumer_id=CUST2345

Query Parameters

Parameter	Required	Description
consumer_id	Yes	One or more consumer IDs to filter by. Repeat this parameter for each additional consumer ID.
scoring_date	No	Scoring date (YYYY-MM-DD)

Headers

Header	Value
x-client-id	`{{X-CLIENT-ID}}`
x-client-secret	`{{X-CLIENT-SECRET}}`
Accept	`application/json`

cURL

curl --request GET \
  --url https://partners.trudenty.com/v1/consumer-trust-index?consumer_id=CUST1234&consumer_id=CUST2345 \
  --header 'x-client-id: YOUR_CLIENT_ID' \
  --header 'x-client-secret: YOUR_CLIENT_SECRET' \
  --header 'Accept: application/json'

Consumer Trust Index History API

Retrieves the historical Consumer Trust Index records for a specified consumer.

Request Configuration

Property	Value
Name	Get Consumer Trust Index History
Method	GET
URL	`{{BASE_URL}}/v1/consumer-trust-index/history`

Postman Request

GET {{BASE_URL}}/v1/consumer-trust-index/history?consumer_id=CUST1234&page=1&limit=10&from_date=2025-01-01&to_date=2025-06-30

Query Parameters

Parameter	Required	Description
consumer_id	Yes	One or more consumer IDs to filter by. Repeat this parameter for each additional consumer ID.
page	No	Page number
limit	No	Number of records per page
from_date	No	Start date (YYYY-MM-DD)
to_date	No	End date (YYYY-MM-DD)

Headers

Header	Value
x-client-id	`{{X-CLIENT-ID}}`
x-client-secret	`{{X-CLIENT-SECRET}}`
Accept	`application/json`

cURL

curl --request GET \
  --url "https://partners.trudenty.com/v1/consumer-trust-index/history?consumer_id=CUST1234&page=1&limit=10&from_date=2025-01-01&to_date=2025-06-30" \
  --header 'x-client-id: YOUR_CLIENT_ID' \
  --header 'x-client-secret: YOUR_CLIENT_SECRET' \
  --header 'Accept: application/json'

Testing Checklist

Before sending requests, verify the following:

✅ The BASE_URL variable is configured correctly.
✅ The X-CLIENT-ID variable contains your assigned Client ID.
✅ The X-CLIENT-SECRET variable contains your assigned Client Secret.
✅ The required authentication headers are included.
✅ The Consumer ID exists in the Trudenty platform.
✅ HTTPS is used for all API requests.

Need Assistance?
If you have questions about onboarding, authentication, or API integration, visit the Contact Support page to explore available support channels and contact our team.

What's Next

Error Handling

Review error handling, best practices, and integration examples.

Best Practices

Recommended integration guidelines.

API Reference

Explore endpoints, request parameters, responses, and examples.