---
updatedAt: 2026-07-23T03:40:09.000Z
---

# Entity match

<span class="market-available-inline" aria-label="Market availability: Global">Market availability: Global</span>

# Overview

The <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/reference/getentitymatch">Entity match</Anchor> API gives Payout Service Providers (PSPs) access to seller entity data. Use it to retrieve key matching details, including the seller’s business identifier, legal business name, and country of incorporation. Depending on the country, the business identifier may be a registration number or tax identifier. Use this API to verify seller information and support compliant payment processing.

**Authentication varies by market**:&#x20;

* **US**: PSPs use [OAuth 2.0 seller authorization](/global-marketplace/docs/oauth-20-authorization-1) via the App Store
* **Canada (CA), Mexico (MX) and Chile (CL)**: PSPs use [delegated access authorization](/global-marketplace/docs/delegated-access-auth)

Entity profile data includes the seller’s business identifier (for example, business registration number or tax identifier depending on country), legal business name, and the country of incorporation. This API can be used by Payout Service Providers (PSPs) to validate if a seller's entity details match during onboarding and payout processes.

Leverage this API to ensure that the seller's information is accurate and compliant, minimizing payment exceptions, and facilitating timely and lawful payment transactions.

***

## Endpoint

```json bash
GET /v3/settings/entitymatchprofile
```
```python
```

# Function

* Retrieves seller entity data, such as business identifier (registration number or tax identifier), legal business name, and Country of Incorporation (COI)
* Access is restricted to select PSPs only
* Allows PSPs to view data for sellers who have authorized the PSP, authenticated using an access token

***

## Prerequisites

Complete the following before you start integrating with the Entity match API:

* Seller must authorize PSP access to the Entity match API.
* PSPs must be authorized to access the Entity match API.
* PSP must obtain necessary access tokens through the Token API and authenticate using those tokens to access the Entity match API.

## Sample request

```curl
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 Marketplace" \
  -H "WM_MARKET: us" \
  -H "WM_GLOBAL_VERSION: 3.1" \
  -H "Accept: application/json"
```
```python
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 Marketplace",
    "WM_MARKET": "us",              # Allowed values: us, ca
    "WM_GLOBAL_VERSION": "3.1",      # The version of the global API used
    "Accept": "application/json"
}

response = requests.get(url, headers=headers)

print(response.status_code)
print(response.json())
```

### Modify your code

1. Use your `WM_SEC.ACCESS_TOKEN` obtained from the Token API.
2. Use your `WM_QOS.CORRELATION_ID` for each request to track and correlate requests and responses across systems.
3. Provide `WM_SVC.NAME` to specify the Walmart service being called.
4. Set `WM_MARKET` to the target market for the API call. Allowed values: `us`, `ca`.
5. Set `WM_GLOBAL_VERSION` to the global API version your integration is targeting. Allowed value: `3.1`.
6. Provide `WM_CONSUMER.CHANNEL.TYPE` if supplied during onboarding to identify the consumer request by channel (optional).

## Sample response

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

## Errors and remediation

<Table align={["right",null,null]}>
  <thead>
    <tr>
      <th style={{ textAlign: "right" }}>
        HTTP status
      </th>

      <th>
        When it happens
      </th>

      <th>
        What to do (remediation)
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td style={{ textAlign: "right" }}>
        404 Not Found
      </td>

      <td>
        Entity profile data is not available for the seller context (for example, tax information is missing/not on file, or the partner context cannot be found).
      </td>

      <td>
        Confirm the seller has completed required tax/entity setup. Verify the seller has authorized your PSP to access entity match data using the applicable authorization method for the market.

        - US: PSPs use [OAuth 2.0 seller authorization](/global-marketplace/docs/oauth-20-authorization-1) via the App Store
        - Canada (CA): PSPs use [delegated access authorization](/global-marketplace/docs/delegated-access-auth).

        Retry after the seller updates their entity/tax information. If it persists, capture. If it persists, capture `WM_QOS.CORRELATION_ID` and contact Walmart support with the correlation ID and timestamp.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "right" }}>
        500 Internal Server Error
      </td>

      <td>
        A temporary server-side error occurred while processing the request.
      </td>

      <td>
        Retry with exponential backoff and jitter. If the error persists, capture `WM_QOS.CORRELATION_ID`, timestamp, and request details, then contact Walmart support.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "right" }}>
        429 Too Many Requests
      </td>

      <td>
        Too many requests sent in a short period; throttling triggered.
      </td>

      <td>
        Implement retries with exponential backoff and jitter. Reduce burst rate and cache responses when possible. Follow the [Rate limiting guide](/global-marketplace/docs/rate-limiting) throttling recommendations.
      </td>
    </tr>
  </tbody>
</Table>

## 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`: Seller business identifier (for example, business registration number or tax identifier depending on country).
* `name`: The seller’s legal business name.
* `countryOfIncorporation`: The country in which the business is legally incorporated/registered.

# Next steps

The **Get shipping template details** API gives you specific shipping configurations for a single shipping template.

* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/docs/get-shipping-template-details">Get shipping template details Guide</Anchor>
* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/reference/getshippingtemplatedetails">Get shipping template details API Reference Guide</Anchor>

The **Update shipping templates** API lets you modify configurations on an existing shipping template, such as shipping methods, regions, transit times, and pricing rules.

* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/docs/update-shipping-templates">Update shipping templates Guide</Anchor>
* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/reference/updateshippingtemplates">Update shipping templates API Reference Guide</Anchor>

The **Delete shipping templates** API lets you permanently remove existing shipping templates from Walmart Marketplace settings.

* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/docs/delete-shipping-templates">Delete shipping template Guide</Anchor>
* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/reference/deleteshippingtemplatedetails">Delete shipping template API Reference Guide</Anchor>

The **Get all fulfillment centers** API retrieves fulfillment centers (also known as ship nodes) information on your account.

* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/docs/get-all-fulfillment-centers">Get all fulfillment centers Guide</Anchor>
* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/reference/getallfulfillmentcenters">Get all fulfillment centers API Reference Guide</Anchor>

The **Update fulfillment center** API helps you update your existing fulfillment centers (also known as a ship nodes) configuration in Marketplace Settings.

* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/docs/update-fulfillment-centers">Update fulfillment centers Guide</Anchor>
* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/reference/updatefulfillmentcenter">Update fulfillment centers API Reference Guide</Anchor>

The **Create fulfillment center&#x20;**&#x41;PI sets up new fulfillment centers (also known as ship nodes) in Walmart Marketplace Settings.

* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/docs/create-fulfillment-center">Create fulfillment center Guide</Anchor>
* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/reference/createfulfillmentcenter">Create fulfillment center API Reference Guide</Anchor>

The **Get account level settings** API retrieves account-level shipping settings such as calendar day configurations, weekends, and additional days off.

* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/docs/get-account-level-settings-1">Get account level settings Guide</Anchor>
* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/reference/getaccountlevelsettings">Get account level settings API Reference Guide</Anchor>

The **Update account level settings** API allows you to configure account-level calendar settings that impact shipping calculations and delivery promise logic.

* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/docs/update-account-level-settings">Update account level settings Guide</Anchor>
* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/reference/updateaccountlevelsettings">Update account level settings API Reference Guide</Anchor>

The **Create account level settings** API lets you establish account level calendar configuration for your shipping operations.

* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/docs/create-account-level-settings">Create account level settings Guide</Anchor>
* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/reference/createaccountlevelsettings">Create account level settings API Reference Guide</Anchor>

The **Get all shipping templates** API retrieves a list of all shipping templates configured on your account.

* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/docs/get-all-shipping-templates">Get all shipping templates Guide</Anchor>
* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/reference/getallshippingtemplates">Get all shipping templates API Reference Guide</Anchor>

The **Create shipping templates** API allows sellers to create custom shipping templates that define shipping methods, transit times, pricing logic, and geographic coverage.

* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/docs/create-shipping-templates">Create shipping templates Guide</Anchor>
* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/reference/createshippingtemplates">Create shipping templates API Reference Guide</Anchor>

The **Third-party fulfillment center association** API allows sellers to activate or update the status of 3PL (third-party logistics) ship nodes associated with your Marketplace account.

* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/docs/third-party-fulfillment-center-association">Third-party fulfillment center association Guide</Anchor>
* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/reference/associate3pfulfillmentcenter">Third-party fulfillment center association API Reference Guide</Anchor>

The **Get shipping configurations** API retrieves account-level shipping profile settings associated on your account.

* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/docs/get-shipping-configurations-1">Get shipping configurations Guide</Anchor>
* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/reference/getshippingconfigurations">Get shipping configurations API Reference Guide</Anchor>

The **Get shipping template activation status** API allows sellers to retrieve the current activation state of shipping templates at the account level.

* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/docs/get-shipping-template-activation-status">Get shipping template activation status Guide</Anchor>
* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/reference/getshippingtemplateactivationstatus">Get shipping template activation API Reference Guide</Anchor>

The **Get coverage for fulfillment centers** API retrieves the geographic coverage areas associated with each fulfillment center (ship node) configured under a seller account.

* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/docs/get-coverage-for-fulfillment-centers">Get coverage for fulfillment centers Guide</Anchor>
* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/reference/getcoverageforfulfillmentcenters">Get coverage for fulfillment centers API Reference Guide</Anchor>

The **Get carrier methods** API retrieves the list of carrier methods available for use in Marketplace shipping configurations

* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/docs/get-carrier-methods">Get carrier methods Guide</Anchor>
* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/reference/getcarriermethods">Get carrier methods API Reference Guide</Anchor>

The **Get all third-party fulfillment providers** API retrieves all third-party fulfillment providers (3PLs) available on the Walmart marketplace.

* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/docs/get-all-third-party-fulfillment-providers">Get all third-party fulfillment providers Guide</Anchor>
* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/reference/get3pfulfillmentproviders">Get all third-party fulfillment providers API Reference Guide</Anchor>

The **Get partner configurations** API retrieves seller-level profile information and system configuration settings associated with a Marketplace partner account.

* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/docs/get-partner-configurations-1">Get partner configurations Guide</Anchor>
* <Anchor target="_blank" href="https://developer.walmart.com/global-marketplace/reference/getpartnerconfigurations">Get partner configurations API Reference Guide</Anchor>

<br />