The public key ID, which is a required request parameter for this method, is retrieved from the Base64-encoded X-EBAY-SIGNATURE header that is included in the eBay notification.
Note: For more details about how to process eBay push notifications and validate notification message payloads, see the Notification API Overview.
Input
Resource URI (production)
URI parameters
| Parameter | Type | Description |
|---|---|---|
| public_key_id | string | The unique key ID that is used to retrieve the public key. Note: This is retrieved from the X-EBAY-SIGNATURE header that is included with the push notification. Occurrence: Required |
HTTP request headers
OAuth scope
This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope
See OAuth access tokens for more information.
Output
| Output container/field | Type | Description |
|---|---|---|
| algorithm | string | The algorithm associated with the public key that is returned, such as Elliptic Curve Digital Signature Algorithm (ECDSA). Occurrence: Always |
| digest | string | The digest associated with the public key that is returned, such as Secure Hash Algorithm 1 (SHA1). Occurrence: Always |
| key | string | The public key that is returned for the specified key ID. This value is used to validate the eBay push notification message payload. Occurrence: Always |
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
| Status | Meaning |
|---|---|
| 200 | OK |
| 404 | Not found |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 195000 | API_NOTIFICATION | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. |
| 195001 | API_NOTIFICATION | REQUEST | The specified public key Id does not exist. |
Warnings
Samples
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.