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 ContentHTTP 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.
Resource URI (production)
HTTP request headers
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):
See OAuth access tokens for more information.
|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.|
If no KYC checks are currently required from the seller, this array is not returned, and the seller only receives a
|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. |
|kycChecks.dueDate||string||The 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:
|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. |
|kycChecks.alert||string||This field gives a short summary of what is required from the seller. An example might be, '|
|kycChecks.detailMessage||string||This field gives a detailed message about what is required from the seller. An example might be, '|
For more on errors, plus the codes of other common errors, see Handling errors.
|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.|
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.