# Common Headers

Source: https://docs.pitchpointsolutions.com/developer_guides/headers/index/

**Stable**

## Overview

In addition to the standard `Content-Type`, `Accept`, and `Authorization` headers, Pitchpoint supports several `X-PPS-*` request headers that apply across all products and API calls. These headers are optional, but are useful for tracking.

> **API Reference:** Need to submit requests on behalf of another user? See [Signing In As Another User](https://docs.pitchpointsolutions.com/developer_guides/authentication/useralias) for the `useralias` sign-in parameter, not a request header.

## X-PPS-UserAlias

Use this header to pass your own internal identifier for the end user or system making the request (for example, an internal username, loan officer ID, or system name).

The value you send is stored with the order and echoed back on your billing records, so you can reconcile Pitchpoint invoices against your own internal users or systems without having to create a Pitchpoint account per user.

```
X-PPS-UserAlias: jsmith
```

This header is for informational/billing purposes only. It does not affect authentication or authorization.

## X-PPS-UserAgent

Use this header to self-identify the calling system making the request (for example, your application or integration name and version).

Unlike the standard `User-Agent` header, which typically describes the HTTP client or library making the request, `X-PPS-UserAgent` lets you identify the actual system or product driving the integration, which is useful when a shared client library sits in front of multiple calling systems.

```
X-PPS-UserAgent: LoanOriginationSystem/2.4
```

This header is for informational/tracking purposes only. It does not affect authentication or authorization.

## X-PPS-CorrelationID

This value is returned on every response, and can be used to track the request across the entire Pitchpoint Solutions stack. If you run into issues with a request, send the Pitchpoint Solutions support team this `X-PPS-CorrelationID` value along with the approximate date/time the request occurred.

```
X-PPS-CorrelationID: 8f14e45f-ceea-467e-adf5-b9a1b4b1c8f0
```

> **Before Starting:** Please be aware that this value is different from the `correlationId` field in the request body. The body's `correlationId` is a business identifier used to identify particular verifications, while `X-PPS-CorrelationID` exists purely so support can trace a request's path through the system.

## x-pps-request-id

When the Session, Workflow, Findings or Webhooks API answers with a problem document (`application/problem+json`), the response carries an `x-pps-request-id` header. Its value is the id of that one request, and it is the same id as the `X-PPS-CorrelationID` response header. The document's `instance` field carries it too, written as `urn:pps:request:<id>`. Quote it when you contact support about a failed request.

```
x-pps-request-id: 00000000-0000-0000-0000-000000000000
```