Get Business Details

Loading...

API endpoint path: /db-bb-core/v1/business-details

Retrieves comprehensive business details for a company or user based on the provided search criteria.

Search Types:

• BUSINESS_ID: Search by the unique business/company identifier
• LOGIN_ID: Search by the user's login ID

Response includes:

• Business name and registration information
• Business address details (street, city, state, zip)
• Primary contact information
• TIN details (optional, when includeTins=true)
• Customer/user details (optional, when includeUsers=true)

Usage Notes:

• The searchType and searchValue parameters are required
• Use BUSINESS_ID search type when you have the company's unique identifier
• Use LOGIN_ID search type when searching by a user's credentials
• Set includeTins=true to retrieve Tax Identification Number details
• Set includeUsers=true to retrieve associated user/customer information

Request

Responses

200

Business details retrieved successfully.

400

Bad Request - Invalid input parameters. Possible causes:

• Invalid searchType

401

Unauthorized - Authentication credentials are missing or invalid.

403

Unauthorized - Invalid roles or entitlements.

500

Internal Server Error - An unexpected error occurred while retrieving business details.