GET/kyc
Note: This method was originally created to see which onboarding requirements were still pending for sellers being onboarded for eBay managed payments, but now that all seller accounts are onboarded globally, this method should now just return an empty payload with a 204 No Content HTTP status code.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com
URI parameters
This method has no URI parameters.
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
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/sell.account
https://api.ebay.com/oauth/api_scope/sell.account.readonly
See OAuth access tokens for more information.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| kycChecks | array of KycCheck | This array contains one or more KYC checks required from a managed payments seller. The seller may need to provide more documentation and/or information about themselves, their company, or the bank account they are using for seller payouts. Occurrence: Conditional |
| kycChecks.dataRequired | DetailsType | The enumeration value returned in this field categorizes the type of details needed for the KYC check. More information about the check is shown in the detailMessage and other applicable, corresponding fields. Occurrence: Conditional |
| kycChecks.dueDate | string | The timestamp in this field indicates the date by which the seller should resolve the KYC requirement. Occurrence: Conditional |
| kycChecks.remedyUrl | string | If applicable and available, a URL will be returned in this field, and the link will take the seller to an eBay page where they can provide the requested information. Occurrence: Conditional |
| kycChecks.alert | string | This field gives a short summary of what is required from the seller. An example might be, ' Occurrence: Conditional |
| kycChecks.detailMessage | string | This field gives a detailed message about what is required from the seller. An example might be, ' Occurrence: Conditional |
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 |
| 204 | No Content |
| 400 | Bad Request |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 20500 | API_ACCOUNT | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. |
| 21400 | API_ACCOUNT | REQUEST | This marketplace is not supported. Please refer to documentation. |
Warnings
This call has no 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.
Sample 1: Get KYC checks
This call retrieves any 'Know Your Customer' (KYC) check action items for managed payments sellers.
Input
No path, query, or request payload parameters are needed for this method.
GEThttps://api.ebay.com/sell/account/v1/kyc
Output
The response included two KYC checks - one check is asking the seller to provide bank account details, and the other is asking the seller to provide company information. A link to Seller Hub is shown for both KYC checks, and this is where the seller can view and provide the requested information.