Field Index for Boarding
This document will have the list of fields for boarding
Introduction
In this section, you will list of field names and definitions used across boarding-related objects, example formats and data types for reference and A reference of product names and their respective IDs for API configuration.
Prerequisites
- Basic understanding of the boarding process and its components
- Universal Account Record (UAR)
- Location, Entity, and Account Objects
Limitations
- The older merchant/v2 API is deprecated and should not be used
- Only the boarding/v1 API version supports the current boarding process
- The boarding flow must follow the required sequence
- Create Universal Account Record (UAR)
- Update Location
- Update Entity
- Update Account
- Finalize Account
- Lack of completion in any step will prevent merchant onboarding
Purpose of this Document
This document will have a list of fields that show up while using our boarding API. This page will have different columns to explain what the fields mean or have.
UAR Object
| Field Name | Description | Data Type | Example |
|---|---|---|---|
| name | Doing Business as Name | String | "Donut Shop" |
| id | Universal Account Record | Enum | "af63a608-3a4b-5a87-b762-ace796c4a0c0" |
| accountId | Id related to the product | Enum | "a51a423c-d2fc-51c7-900a-9e84c8014d23" |
| entityId | Id related to the Entity Object | Enum | "8d873027-750f-5b96-944c-2cc039353053" |
| locationId | Id related to the Location Object | Enum | "d3fb7268-b97f-5cc1-b74f-50ea803ee24c" |
Entity Object
| Field Name | Description | Data Type | Example |
|---|---|---|---|
| id | Id related to the Entity Object | Enum | "8d873027-750f-5b96-944c-2cc039353053" |
| address | Address of the Entity | Object: Array of Strings | "address": { "city": "Alpharetta", "country": "United States", "postalCode": "30004", "state": "GA", "street1": "South Main Street" } |
| jurisdiction | Information of the Entity type | Object: Array of Strings | Jurisdictions Fields |
| Email address | email string | [email protected] | |
| signers | Object that holds all info regarding the ownership | Object: Array of Strings | Signers Fields |
| taxId | Entity Tax Id Information (different from signers) | Object: Array of Strings | "taxId": { "type": "EIN", "valid": false, "number": "555555555" } |
| type | Tax Type | Enum | "EIN" or "SSN" |
| valid | Whether identification is valid or not. | boolean | "false" |
| number | number of the tax type | String | "555555555" |
Location Object
| Field Name | Description | Data Type | Example |
|---|---|---|---|
| established | Date that this location has been established | String Date format - "YYYY-MM-DD" | "2002-12-23" |
| id | ID field of the location object | enum | "d3fb7268-b97f-5cc1-b74f-50ea803ee24c" |
| industry | Business industry the location is associated with | Enum | Coming Soon |
| sector | Sector the business industry is a part of. | Enum | Coming Soon |
| sic | Number Code of the Sic | Enum | Coming Soon |
| address | Location of DBA | Object: Array of Strings | "address": { "city": "Alpharetta", "country": "United States", "postalCode": "30004", "state": "GA", "street1": "South Main Street" } |
| phone | 10 Digit telephone number. | 10 Character String | "4043217894" |
| name | Name of the DBA. | "String" | "Donut Shop" |
Product List
| Product | Product ID |
|---|---|
| MX Merchant | 5 |
| Brinks 2 | 440ac9e0-a714-5840-b67a-a849dff2c832 |
| TSYS | 3 |
| LandlordStation | 7ee804ae-873f-5132-a19c-85930d585cdd |
| Brinks | 2be97b91-7baf-58c9-9811-9fab1a608bae |
| Priority CBD | eb8d81d5-a59a-5662-9026-04f6fd9577cd |
| ACH.COM | 1 |
| FirstData | 2 |
| Chase Paymentech | 616173d5-6bb0-561e-8e0f-5b572ca44bfb |
| Authorize.Net | c9eef8ad-25d7-5ac0-aff7-5777343bd9ad |
| Apriva | da9ce53e-a239-51f4-808d-de838bcc8c39 |
| MX Insights | 4 |
| MX Connect | 421b375a-8143-57cc-9dc5-ad5ee2eab098 |
| RadPad | 1075859c-24b2-5b6b-be3c-7bec08b23ee4 |
| Payright Health | 8e520e3b-d2ad-5cde-af0f-eab32b79abef |
| e-tab | f5f0b208-c294-5cf3-b211-16e58407bf98 |
Account Object
Coming Soon
Updated 30 days ago