X-Request-Log-Id Response Header

Every API response from Check includes an X-Request-Log-Id header containing a unique identifier for that request. You can use this identifier to reference specific API requests when contacting Check support for debugging assistance.

Header Format

The X-Request-Log-Id header value follows this format:

log_XXXXXXXXXXXXXXXXXXXX

Where X represents alphanumeric characters (a-z, A-Z, 0-9). The identifier is always 24 characters: a log_ prefix followed by 20 random alphanumeric characters.

Example

HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Log-Id: log_aB3cDeFgHiJkLmNoPqRs

{
  "id": "emp_abc123...",
  ...
}

Using the Request Log ID

When troubleshooting an issue with a specific API request, you can use the X-Request-Log-Id value to look up the log in Console in the API Logs screen. You can also share the log ID when contacting Check's support, which allows our team to quickly locate the exact request in our logs and provide faster, more accurate assistance.

Best Practices

Log the header value - When making API requests, capture and log the X-Request-Log-Id from each response alongside your own application logs.
Include it in error reports - If your integration encounters an error, include the X-Request-Log-Id in any bug reports or support tickets.
Correlate with your traces - Use the request log ID to correlate Check's API request logs with your own distributed tracing system for end-to-end debugging.

Example: Capturing the Header

import requests

response = requests.post(
    "https://api.checkhq.com/employees",
    headers={"Authorization": "Bearer sk_test_..."},
    json={"company": "com_123", "first_name": "Jane", ...}
)

request_log_id = response.headers.get("X-Request-Log-Id")
print(f"Request Log ID: {request_log_id}")

# Log this ID alongside your application logs for future reference
logger.info("Created employee", extra={
    "check_request_log_id": request_log_id,
    "status_code": response.status_code
})

const response = await fetch("https://api.checkhq.com/employees", {
  method: "POST",
  headers: {
    "Authorization": "Bearer sk_test_...",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({ company: "com_123", first_name: "Jane", ... })
});

const requestLogId = response.headers.get("X-Request-Log-Id");
console.log(`Request Log ID: ${requestLogId}`);

Contacting Support

When reaching out to Check support about an API issue, include:

The X-Request-Log-Id value from the response
The approximate time the request was made
A description of the expected vs. actual behavior

This information helps our support team investigate issues efficiently.