Entity Match API

The Entity Match API allows the Payout Service Providers (PSPs) to retrieve essential matching data for sellers such as the seller's tax ID, legal business name, and country of incorporation. Use this API to gather and verify critical seller information, ensuring compliance and validating business details for accurate and lawful payment processing..

Endpoint

GET /v3/settings/entitymatchprofile

Throttling

This API endpoint is throttled—if you submit too many feeds too quickly, you might hit Walmart’s rate limits and receive HTTP 429 responses. To learn more about throttling, refer to the Marketplace throttling documentation.

Sample request

curl -X GET "<https://marketplace.walmartapis.com/v3/settings/entitymatchprofile"> -H "WM_SEC.ACCESS_TOKEN: your_access_token" -H "WM_CONSUMER.CHANNEL.TYPE: your_channel_type" -H "WM_QOS.CORRELATION_ID: your_correlation_id" -H "WM_SVC.NAME: Walmart Service Name" -H "Accept: application/json"

import requests url = "https://marketplace.walmartapis.com/v3/settings/entitymatchprofile" headers = { "WM_SEC.ACCESS_TOKEN": "your_access_token", "WM_CONSUMER.CHANNEL.TYPE": "your_channel_type", "WM_QOS.CORRELATION_ID": "your_correlation_id", "WM_SVC.NAME": "Walmart Service Name", "Accept": "application/json"
} response = requests.get(url, headers=headers) print(response.status_code)
print(response.json())

Modify your code

1. Use your unique WM_SEC.ACCESS_TOKEN obtained from the Token API.
2. Use your unique WM_CONSUMER.CHANNEL.TYPE ID to specify the type of channel through which the request is being made.
3. Use your unique WM_QOS.CORRELATION_ID for each request, which helps to track and correlate requests and responses across different systems.

Sample response

[ { "body": { "businessRegistrationNumber": "ABCD0050", "name": "Collins Goods LLC", "countryOfIncorporation": "HK" }, "status": "OK" }
]

Result

If successful, the API response returns an HTTP status: 200 OK with a JSON payload containing the matching entity data of the seller, including:

• businessRegistrationNumber: The tax identification number of the seller.
• businessName: The legal business name of the seller.
• countryOfIncorporation: The country in which the the business is legally registered.