Updating the Location

Introduction

In this section, you will learn the role of the Location object in merchant onboarding, how to construct and submit a location update request and field-level expectations such as address, sector, and SIC codes.

Note: As of September 2021, our documentation refers to the new MXC boarding APIs. If you would like to review documentation referencing our old boarding APIs, please change the page version from v2 to v1 at the top left corner

Prerequisites

• A UAR must already be created with a valid locationId
• JWT token obtained through MXConnect authentication
• Partner domain ID for use in the payload
• Access to required location data including:
  • Street address
  • Phone number
  • Industry, sector, and SIC code
  • Business establishment date

Limitations

• The locationId must be captured from the UAR response to use in the update request
• Some fields such as sector and industry may be listed as “Coming Soon” in documentation and may not yet be enforced or available for use
• Incomplete or improperly formatted address data may result in submission failure
• Accurate classification (SIC/NAICS) is critical for downstream compliance and risk evaluation

Location Object

The Location Object contains most of the data regarding the address, date established, industry, etc. This section below shows an example payload of a complete Location Object. More explanations of the fields can be found on the Field Index for Boarding page.

PUT https://api.mxconnect.com/boarding/v1/uar/(locationIDHere)/location

{
    "domain": {
        "id" : "00000000-0000-0000-0000-000000000001"
    },
    "research": {
        "products": "Technology"
    },
    "established": "2002-02-02",
    "active": false,
    "industry": "Technology",
    "address": {
        "postalCode": "30350",  
        "city": "Sandy Springs",
        "country": "United States",
        "state": "GA",
        "street1": "223 February Street"
    },
    "phone": "3143433433",
    "sector": "Real Property Lessors, Nec",
    "id": "e9bab0f6-4197-5e64-a0e1-e2f26b9365c3",
    "sic": "68209",
    "name": "API Test Location"
}