account APIv1.6.0

getKYC

GET
/kyc
This method is used by sellers onboarded for eBay managed payments, or sellers who are currently going through, or who are eligible for onboarding for eBay managed payments. With this method, a seller can discover if there are any action items in regards to providing more documentation and/or information about themselves, their company, or the bank account they are or will be using for seller payouts. These 'action items' are also know as 'Know Your Customer' (or KYC) checks.

This method does not require any parameters other than the OAuth user token associated with the seller's account.

If the managed payments seller does not currently have any pending 'KYC' action items, only a 204 No Content HTTP status code is returned, and no response payload.

Note: This method is not applicable for sellers who are not eligible for eBay managed payments. For sellers who sell on one or more eBay marketplaces that currently support managed payments, they can check on their managed payments onboarding status by using the getPaymentsProgramOnboarding method.

Input

Resource URI (production)

GET https://api.ebay.com/sell/account/v1/kyc

URI parameters

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

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.

Output

HTTP response headers

Output container/fieldTypeDescription
kycChecksarray of KycCheckThis 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.

If no KYC checks are currently required from the seller, this array is not returned, and the seller only receives a 204 No Content HTTP status code.

Occurrence: Conditional

kycChecks.dataRequiredDetailsTypeThe 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.dueDatestringThe timestamp in this field indicates the date by which the seller should resolve the KYC requirement.

The timestamp in this field uses the UTC date and time format described in the ISO 8601 Standard. See below for this format and an example:

MM-DD-YYYY HH:MM:SS
06-05-2020 10:34:18

Occurrence: Conditional

kycChecks.remedyUrlstringIf 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.alertstringThis field gives a short summary of what is required from the seller. An example might be, 'Upload bank document now.'. The detailMessage field will often provide more details on what is required of the seller.

Occurrence: Conditional

kycChecks.detailMessagestringThis field gives a detailed message about what is required from the seller. An example might be, 'Please upload a bank document by 2020-08-01 to get your account back in good standing.'.

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.

StatusMeaning
200OK
204No Content
400Bad Request
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
20500API_ACCOUNTAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
21400API_ACCOUNTREQUESTThis marketplace is not supported. Please refer to documentation.

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.
GET
https://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.