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:

• GET/business: Gets a list of all business customers
• POST/business: Registers a new business
• POST/business/initiate: Initiate a new business
• POST /business/unblock/{id}: Only Update the Status Of the Business Customer
• POST /business/whitelist/{id}: WhiteLists a Business Customer
• GET/business/{id}: Retrieves all details of a business corresponding to an ID (Admin use only)
• PATCH /business/{id}: Updates Business customer
• PUT/business/{id}: Updates allowed fields of a business
• GET/business/{id}/accounts: Gets a list of accounts belonging to a Business Customer
• GET/business/{id}/ubo: Gets a list of UBOs associated with a business account
• POST/business/{id}/ubo: Creates a new UBO
• GET/business/{id}/ubo/KYC: Retrieves identity verifications for all UBOs in a business
• POST/business/{id}/ubo/KYC: Creates identity verifications for all UBOs in a business
• DELETE/business/{id}/ubo/{uboId}: Deletes a UBO
• GET/business/{id}/ubo/{uboId}: Retrieves a UBO
• PUT/business/{id}/ubo/{uboId}: Updates a UBO
• GET/business/{id}/ubo/{uboId}/KYC: Retrieves an identity verification for a UBO
• POST/business/{id}/ubo/{uboId}/KYC: Creates an identity verification for a UBO

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:

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