1. Customer Sign In
- Using your login credentials you will sign into the customer portal via the API Customer Sign In endpoint
- Upon signing in you will get an
id_token
andcustomer_id
- These two identifiers are needed to make the Add Business call
2. Add Business
For more information on the Add Business route, please see the API Reference for Add Business.-
The following four data fields are the MINIMUM requirements needed to Add a Business:
-
Authorization: REQUIRED
- Insert the
id_token
captured from the Customer Sign In call for authentication
- Insert the
-
Customer ID: REQUIRED
- Insert the
customer_id
captured from the Customer Sign In call for authentication
- Insert the
-
External ID: REQUIRED
- This is any unique identifier that you want to use for this business
-
Name: REQUIRED
- This is the name of the company that you are adding
-
Authorization: REQUIRED
The following fields are recommended when making the Add Business call for KYB, as it will return a more robust data set:
Field Name | Required / Recommended | Notes |
---|---|---|
name | ✅ Required | Legal business name |
external_id | ✅ Required | Internal identifier for tracking |
tin (Tax ID) | 🔶 Recommended | Strongest match for business identity |
address_line_1 | 🔶 Recommended | Business street address |
address_city | 🔶 Recommended | City of the business |
address_state | 🔶 Recommended | State where business operates |
address_postal_code | 🔶 Recommended | ZIP/Postal code |
naics_code or mcc_code | 🔶 Recommended | Industry classification business code |
year_created | 🔶 Recommended | The year the company was created |
annual_total_income | 🔶 Recommended | Business revenue |
official_website | 🔶 Recommended | Company website |
The following fields are recommended when making the Add Business call for KYC, as it will return a more robust data set:
Field Name | Required / Recommended | Notes |
---|---|---|
owner1_first_name | 🔶 Recommended | Individual’s legal first name |
owner1_last_name | 🔶 Recommended | Individual’s legal last name |
owner1_mobile | 🔶 Recommended | Personal contact number |
owner1_email | 🔶 Recommended | Primary email address |
owner1_dob | 🔶 Recommended | Used for identity matching (encrypted) |
owner1_ssn | 🔶 Recommended | Encrypted — critical for verification |
owner1_address_line_1 | 🔶 Recommended | Home street address |
owner1_address_line_2 | 🔶 Recommended | Apartment / Suite / Unit |
owner1_address_city | 🔶 Recommended | Residential city |
owner1_address_state | 🔶 Recommended | Residential state |
owner1_address_postal | 🔶 Recommended | ZIP code of the residential address |
owner1_title | ✅ Required | Insert one of the following strings: Partner, Limited Partner, Director, Chief Accounting Officer, Chief Executive Officer, Chief Operations Officer, President, Vice President, Treasurer, Assistant Treasurer, 1% Shareholder, Shareholder, Controller, Managing Member, Owner, Sole Proprietor, Executor, Beneficiary, Trustee, Administrator |
owner1_owner_type | ✅ Required | Insert one of the following strings: CONTROL or BENEFICIARY |
Viewing Add Business call in your Customer Portal
If you are using the Customer Portal you can validate the businesses that have been onboarded by following these two steps: Step 1: Once the business is added, you can log into your customer account and review the business onboarded. Step 2: Once logged in, on the left nav bar, click on Businesses and you will see the business you onboarded.- Click on “View Details”
- Click on the unique “Ticket Number”
- You will now see company verification details, KYB and other verifications and validations automatically populate into the portal from the Add Business Call