Universal Account Record

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

What is a UAR?

A Universal Account Record will be referred to as UAR, which is how we address new merchants that are newly onboarding to our system. In the User Interface, you are able to create merchants by simply adding a new application, filling out the application, and then sending it to the merchant. Here, you can generate a UAR by completing these steps!

The UAR comprises three main sections: Location, Entity, and Account.

How to Create a UAR?

Creating a UAR in our system requires a few steps. You will first need an authentication token. More information can be found here: MXConnect API Authentication Instructions.

POST https://api.mxconnect.com/boarding/v1/uar.

When making this POST endpoint a body will be required. The body of this endpoint will need the following information: Account, creator, domain, entity, and location. Look at the example below:

{
    "location": {
        "name": "Jason API Test",
        "domain": {
            "id": "00000000-0000-0000-0000-000000000001"
        }
    },
    "account": {
        "status": "Draft",
        "domain": {
            "id": "00000000-0000-0000-0000-000000000001"
        }
    },
    "entity": {
        "domain": {
            "id": "00000000-0000-0000-0000-000000000001"
        }
    }
}

Let's breakdown on what each of the objects needs.

Account

This field needs to have "status": "draft". This is because you are creating an application for a Merchant, so it has not been completed yet. The enum value will be draft.

Entity

This field can be left blank, but be wary that you will be filling out this field later on.

Location

This field should have one subfield called "name" which should have the name of the location in this field.

After sending off the call you will receive a 200ok Response similar to below

{
    "location": {
        "name": "ENTER_NAME_HERE",
        "acl": [
            "Merchant_Account:fc988483-c7a2-5a69-b4bb-afadbdc5a5b7",
            "Merchant_Location:96a4509b-4b81-5276-873f-724a40d4f32b"
        ],
        "platform": "vortex",
        "active": false,
        "entityId": "5b7014e4-64e6-53e5-a983-21093c1d8967",
        "created": "2021-09-10T13:44:43.834Z",
        "creator": {
            "id": "d3e47973-33d9-5279-9d57-319c3ed35d6e",
            "username": "[email protected]"
        },
        "modified": "2021-09-10T13:44:43.834Z",
        "modifier": {
            "id": "d3e47973-33d9-5279-9d57-319c3ed35d6e",
            "username": "[email protected]"
        },
        "id": "96a4509b-4b81-5276-873f-724a40d4f32b"
    },
    "account": {
        "status": "Draft",
        "acl": [
            "Merchant_Account:113d6158-fc62-5922-b0c1-2cd0f96d4365"
        ],
        "active": false,
        "platform": "vortex",
        "events": {
            "draft": {
                "date": "2021-09-10T13:44:43.787Z",
                "modifier": {
                    "id": "d3e47973-33d9-5279-9d57-319c3ed35d6e",
                    "username": "[email protected]"
                }
            }
        },
        "entityId": "5b7014e4-64e6-53e5-a983-21093c1d8967",
        "locationIds": [
            "96a4509b-4b81-5276-873f-724a40d4f32b"
        ],
        "created": "2021-09-10T13:44:43.833Z",
        "creator": {
            "id": "d3e47973-33d9-5279-9d57-319c3ed35d6e",
            "username": "[email protected]"
        },
        "modified": "2021-09-10T13:44:43.833Z",
        "modifier": {
            "id": "d3e47973-33d9-5279-9d57-319c3ed35d6e",
            "username": "[email protected]
        },
        "id": "113d6158-fc62-5922-b0c1-2cd0f96d4365"
    },
    "entity": {
        "research": {
            "bankruptcy": false
        },
        "jurisdiction": {
            "country": "United States",
            "established": "2000-01-01",
            "kind": "Individual or Sole Proprietor",
            "name": "ENTER_NAME_HERE",
            "state": "GA"
        },
        "taxId": {
            "number": {
                "data": {
                    "method": "aes256skv1",
                    "encoding": "utf8",
                    "cryptoAlgorithm": "aes-256-cbc",
                    "iv": "sdNktuLGw3d6MQYby/hMtQ==",
                    "key": {
                        "iv": null,
                        "encoding": "base64",
                        "keyId": 2017042702001,
                        "data": "Jw4Y5JtwpKKkAkAbazhSDWO9yFXjsnRUP/oyiECO+suho6bCiEwe94QQxgexlhv9",
                        "method": "hsmv1",
                        "hash": "/F0qLR7oThamZvJM6D84nfnNpERBCNEa4rE1RWvE1kg="
                    },
                    "data": "yUC9PtCmaW72G5elz17/Eg=="
                },
                "hash": "f5pU7kzRZtcnmValo4kgTdYsrCiHScdaTS599C1IKtg=",
                "mask": "3333"
            },
            "type": "SSN",
            "valid": false
        },
        "signers": [
            {
                "primary": true,
                "id": "e0a107c9-6561-598f-88ec-cbde7c7ff7f0",
                "primaryIdentification": {},
                "secondaryIdentification": {}
            }
        ],
        "acl": [
            "Merchant_Account:eb39a059-55a4-56e5-bb5f-f91bfc739180",
            "Merchant_Entity:5b7014e4-64e6-53e5-a983-21093c1d8967"
        ],
        "platform": "vortex",
        "active": false,
        "created": "2021-09-10T13:44:43.834Z",
        "creator": {
            "id": "d3e47973-33d9-5279-9d57-319c3ed35d6e",
            "username": "[email protected]"
        },
        "modified": "2021-09-10T13:44:43.834Z",
        "modifier": {
            "id": "d3e47973-33d9-5279-9d57-319c3ed35d6e",
            "username": "[email protected]"
        },
        "id": "5b7014e4-64e6-53e5-a983-21093c1d8967"
    },
    "acl": [
        "Merchant_Account:113d6158-fc62-5922-b0c1-2cd0f96d4365"
    ],
    "created": "2021-09-10T13:44:44.470Z",
    "creator": {
        "id": "d3e47973-33d9-5279-9d57-319c3ed35d6e",
        "username": "[email protected]"
    },
    "modified": "2021-09-10T13:44:44.470Z",
    "modifier": {
        "id": "d3e47973-33d9-5279-9d57-319c3ed35d6e",
        "username": "[email protected]"
    },
    "id": "8b766903-6893-5b71-8bb0-0f590589852d"
}