Update the Entity

Introduction

In this section, you will learn the purpose and strucutre of the entity object, the API endpoint and expected payload for updating an entity, and field requirements including jurisdiction, address, tax ID, and signers.

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

UAR must already be created with a valid entityId
JWT authentication token obtained from the MXConnect Security API
Partner domain ID to be included in the request payload
Business information such as legal structure, tax ID, signer details, and address

Limitations

The entityId must be retrieved from the initial UAR response and is required in the update endpoint
The signer object requires complete and accurate personal and identification details; partial data may cause submission failure
The entity information must be updated before account finalization can occur
Field validation is not granular at the API level—developers must consult the Field Index to ensure accuracy

Entity

One of the parts that are needed to board a merchant into MX™ Connect is the account body. Below is an of the JSON body. The endpoint to update the endpoint:

PUT https://api.mxconnect.com/boarding/v1/uar/(entityIDHere)/entity


{
        "domain": {
            "id": "00000000-0000-0000-0000-000000000001"
        },
        "platform": "vortex",
        "research": {
            "bankruptcy": false
        },
        "jurisdiction": {
            "established": "2002-02-02",
            "country": "United States",
            "kind": "Individual or Sole Proprietor",
            "state": "GA",
            "name": "RiverLegal"
        },
        "address": {
            "postalCode": "30350",
            "city": "Sandy Springs",
            "country": "United States",
            "state": "GA",
            "street1": "223 February Street"
        },
        "taxId": {
            "number": "333333333",
            "valid": false,
            "type": "SSN"
        },
        "email": "[email protected]",
        "signers": [
            {
                "secondaryIdentification": {
                    "taxIdNumber": "333333333",
                    "taxType": "Passport",
                    "countryOfIssuance": "US"
                },
                "taxType2": "Passport",
                "phone": "3143433433",
                "primary": true,
                "firstName": "API Test",
                "email": "[email protected]",
                "primaryIdentification": {
                    "taxIdNumber": "333333333",
                    "taxType": "SSN",
                    "countryOfIssuance": "US"
                },
                "taxType": "SSN",
                "lastName": "Cha",
                "dob": "2002-02-02",
                "address": {
                    "postalCode": "30350",
                    "city": "Sandy Springs",
                    "country": "United States",
                    "state": "GA",
                    "street1": "223 February Street"
                },
                "title": "CEO",
                "unitedStatesCitizen": true,
                "ownership": 100,
                "id": "1"
            }
        ]
    }