Request IDs

Every API response includes a request ID. Use it when debugging a request, comparing logs, or contacting Syntage support about a specific API call. The request ID is returned in the X-Request-ID response header.

curl -i 'https://api.syntage.com/entities' \
  --header 'Accept: application/ld+json' \
  --header 'X-Api-Key: {apiKey}'

HTTP/1.1 200 OK
Date: Sun, 29 Nov 2020 19:21:21 GMT
X-Request-ID: f242e9e0-c1ba-4bbe-ba64-4966c702b5d2

When to use it

Include the request ID when you contact support or investigate a failed request. It lets Syntage identify the exact API request without relying on timestamps, endpoint names, or partial payload details.

Log the X-Request-ID value with your own application logs when possible. This makes it easier to trace a request across your application and Syntage.

Example

curl -i 'https://api.syntage.com/entities/{entityId}/tax-status' \
  --header 'Accept: application/ld+json' \
  --header 'X-Api-Key: {apiKey}'

HTTP/1.1 200 OK
Date: Sun, 29 Nov 2020 19:21:21 GMT
X-Request-ID: f242e9e0-c1ba-4bbe-ba64-4966c702b5d2
Content-Type: application/ld+json

Entity URLs Rate Limiting

⌘I

Start here

API concepts

Integration guides

Header

When to use it

Example

​Header

​When to use it

​Example

Header

When to use it

Example