Appearance
Headers
Handshake
The Handshake header is an optional HTTP header that can be provided in API requests to help identify the external party (e.g., partner, client system, integration consumer) making the call. Header value that corresponds to a known identifier in the system
Header definition
| Name | Type | Required | Purpose |
|---|---|---|---|
| Handshake | Guid | No | To identify the calling system or partner |
Example
json
GET /api/v1/resources HTTP/1.1
Host: api.example.com
Handshake: 1c069b92-de34-4df2-88cd-2302429f34a0