Request Correlation

The Passport APIs enable client applications to correlate and trace each individual call made to the Platform. Clients can use this capability to group calls as part of a single business process flow (or transaction) and to uniquely identify each call made within that flow. Passport supports this in two ways:

Request ID

Each invocation of a Passport API will generate an id that uniquely identifies that specific execution of the API. This ID will be returned to the client within a custom HTTP response header: Passport-Labs-Request-Id. Clients may use this ID to log the result of a specific call to one of Passport’s APIs. If there is a problem with a request, this ID can be provided to Passport to help identify and troubleshoot the issue.

Client Trace ID

Passport also enables a client to provide their own correlation id as part of each API request. This ID allows a client to tie, or correlate, multiple calls to a single business process flow. Each Passport API supports a custom HTTP request header: Passport-Labs-Client-Trace-Id. Clients can populate this header with an identifer that they generate and Passport will echo the value back in the response to that request. The value is returned in a custom response header of the same name.