Skip to content

Business Profile

Resource representing a business's identification and contact information.

The Business Profile resource contains information about a business entity, including its identification details and contact information.

Endpoints

MethodUrl
GET/v1.0/business-profiles/:profile_id
GET/v1.0/jobs/:job_id/business-profile
POST/v1.0/users/:user_id/business-profile
PUT/v1.0/business-profiles/:profile_id
POST/v1.0/jobs/:job_id/checklist/:supporting_item_id/provide-business-info

Properties

id
string

Unique identifier of the profile.

version
number

Version number of the profile. Any update increments this number.

workspace_id
string

ID of the workspace the profile belongs to.

owner_user_id
string

ID of the user that owns the profile.

create_time
string

Timestamp when the profile was created.

update_time
string

Timestamp when the profile was last updated.

business_info
BusinessInfo

Object containing the business's identification information. See the business info object.

contact_info
ContactInfo

Object containing the business's contact details. See the contact info object.

Copied
1{
2 "id": "3b31f309-93ad-463a-ad1d-c39cac1c0a3d",
3 "version": 1,
4 "workspace_id": "ws_12345",
5 "owner_user_id": "550e8400-e29b-41d4-a716-446655440000",
6 "create_time": "2024-01-01T00:00:00Z",
7 "update_time": "2024-01-01T00:00:00Z",
8 "business_info": {
9 "business_name": "Acme Corporation",
10 "date_of_incorporation": "01/01/2020",
11 "employer_identification_number": "12-3456789"
12 },
13 "contact_info": {
14 "email": "contact@acme.com",
15 "phone_number": "+1-555-555-5555",
16 "address": {
17 "address_line_1": "123 Business Ave",
18 "address_line_2": "Suite 100",
19 "city": "Miami",
20 "region": "FL",
21 "postal_code": "33134",
22 "country": "United States"
23 }
24 }
25}

Business Info

business_name
string
required

The legal name of the business.

date_of_incorporation
string

The business's date of incorporation (MM/DD/YYYY).

employer_identification_number
string

The business's Employer Identification Number (EIN).

Contact Info

email
string

The business email address.

phone_number
string

The business phone number. This will be formatted to include country code if not already included.

address
PhysicalAddress

The physical business address. See the physical address object.

Physical Address

address_line_1
string

First line of the address.

address_line_2
string

Second line of the address.

city
string

The city.

region
string

The region (state/province/territory).

postal_code
string

The postal code.

country
string

The country.

Last updated on December 9, 2024