​
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 and customer_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:

    1. Authorization: REQUIRED

      • Insert the id_token captured from the Customer Sign In call for authentication

    2. Customer ID: REQUIRED

      • Insert the customer_id captured from the Customer Sign In call for authentication

    3. External ID: REQUIRED

      • This is any unique identifier that you want to use for this business

    4. Name: REQUIRED

      • This is the name of the company that you are adding

Important Note: while there are only four required fields for the Add Business route, the more information that is captured in the Add Business data fields, the more robust and enriched the KYB/KYC response data will be.

Required/Recommended Fields: KYB
The following fields are recommended when making the Add Business call for KYB, as it will return a more robust data set:

Field NameRequired / RecommendedNotes
name✅ RequiredLegal business name
external_id✅ RequiredInternal identifier for tracking
tin (Tax ID)🔶 RecommendedStrongest match for business identity
address_line_1🔶 RecommendedBusiness street address
address_city🔶 RecommendedCity of the business
address_state🔶 RecommendedState where business operates
address_postal_code🔶 RecommendedZIP/Postal code
naics_code or mcc_code🔶 RecommendedIndustry classification business code
year_created🔶 RecommendedThe year the company was created
annual_total_income🔶 RecommendedBusiness revenue
official_website🔶 RecommendedCompany website

Required/Recommended Fields: KYC
The following fields are recommended when making the Add Business call for KYC, as it will return a more robust data set:

Field NameRequired / RecommendedNotes
owner1_first_name🔶 RecommendedIndividual’s legal first name
owner1_last_name🔶 RecommendedIndividual’s legal last name
owner1_mobile🔶 RecommendedPersonal contact number
owner1_email🔶 RecommendedPrimary email address
owner1_dob🔶 RecommendedUsed for identity matching (encrypted)
owner1_ssn🔶 RecommendedEncrypted — critical for verification
owner1_address_line_1🔶 RecommendedHome street address
owner1_address_line_2🔶 RecommendedApartment / Suite / Unit
owner1_address_city🔶 RecommendedResidential city
owner1_address_state🔶 RecommendedResidential state
owner1_address_postal🔶 RecommendedZIP 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✅ RequiredInsert one of the following strings: “Control” or “Beneficial owner”

​
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