Businesses

Welcome to the Businesses section of our API documentation and reference guide. This area facilitates the comprehensive management of business customers through an array of endpoints. From registering new businesses (POST /business), initiating a new business, managing customer status like unblocking, and whitelisting, retrieving complete business details, to updating customer information, this suite serves all your needs.

Businesses Endpoints

Here are the endpoints for the Businesses section:

Main Objects:

The primary objects in the code are:

ach Object:

This object includes data regarding the business's external bank account details. The external bank account will be used to deposit to / withdrawal from the business's braid account.

  • accountNumber: It is a unique number representing a bank account in the ACH.
  • bankAccountType: It represents the type of bank account such as ‘Savings’ or ‘Checking’.
  • bankName: It refers to the name of the bank of the account holder.
  • routingNumber: It refers to the ACH routing number of the bank where the account is held.

address Object:

The address object refers to the address of the business. Each component of the address object represents a detailed location:

  • city: This represents the city of the address.
  • line1: This specifies the first line of the address.
  • line2: This specifies the second line of the address (if any).
  • state: This represents the state of the address.
  • type: This signifies the type of the address; in this case, ‘MAILING’.
  • postalCode: (string) The postal code of the individual's address.
  • countryCode: (string) The country code of the individual's address.

submittedBy Object:

The submittedBy object contains the contact details of the person who submitted the request.

  • contactPersonEmail: It refers to the Email Id of the contact person.
  • contactPersonFirstName: It denotes the first name of the contact person.
  • contactPersonLastName: It signifies the last name of the contact person.
  • contactPersonPhone: It’s the contact phone number of the contact person.

Parameters

Here is a table with Businesses parameters, default values, and definitions:

ParameterDefault ValueDefinition
ach.accountNumber"string"Account number for ACH (Automated Clearing House)
ach.bankAccountType"SAVINGS"Type of bank account used in ACH
ach.bankName"string"Name of the bank for the ACH
ach.routingNumber"string"Bank routing number for ACH
address.city"string"City part of the address
address.line1"string"First line of the street address
address.line2"string"Second line of the street address (optional)
address.state"string"State part of the address
address.type"MAILING"Type of the address (residential, business, mailing, etc.)
address.postalCode"string"Postal code part of address
businessEntityType"SOLE_PROPRIETOR"Type of business entity
businessIdType"EIN"Type of business identification number
dba"string"Business name used in public ("doing business as")
email"string"Email address
formationDate"2024-02-02T17:21:59.402Z"Date of business formation
idNumber"string"Identifier number
incorporationState"string"State of business incorporation
mobilePhone"string"Mobile phone number
name"string"Name of the business
productId0Product identifier
submittedBy.contactPersonEmail"string"Email of person submitting
submittedBy.contactPersonFirstName"string"First name of person submitting
submittedBy.contactPersonLastName"string"Last name of person submitting
submittedBy.contactPersonPhone"string"Phone number of person submitting
website"string"Business/individual's website

Note: The default values, 'string' and '0', are placeholders; you would replace them with actual data when sending a request.