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
| Method | Url |
|---|---|
GET | /v1.0/business-profiles/:profile_id |
GET | /v1.0/jobs/:job_id/business-profile |
GET | /v1.0/users/:user_id/business-profiles |
POST | /v1.0/users/:user_id/business-profile |
PUT | /v1.0/business-profiles/:profile_id |
POST | /v1.0/business-profiles/:profile_id/delist |
POST | /v1.0/jobs/:job_id/checklist/:supporting_item_id/provide-business-info |
Properties
Unique identifier of the profile.
Version number of the profile. Any update increments this number.
ID of the workspace the profile belongs to.
ID of the user that owns the profile.
Timestamp when the profile was created.
Timestamp when the profile was last updated.
Object containing the business's identification information. See the business info object.
Object containing the business's contact details. See the contact info object.
Present if the business profile has been delisted. Omitted if the profile is still listed. See the delist info object.
jsonCopied1{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
The legal name of the business.
The business's date of incorporation (MM/DD/YYYY).
The business's Employer Identification Number (EIN).
Contact Info
The business email address.
The business phone number. This will be formatted to include country code if not already included.
The physical business address. See the physical address object.
Physical Address
First line of the address.
Second line of the address.
The city.
The region (state/province/territory).
The postal code.
The country.
Delist info
Present when a business profile has been delisted. Contains information about when and by whom the profile was delisted.
ISO 8601 timestamp of when the business profile was delisted.
ID of the user who delisted the business profile.
Example (delisted profile)
jsonCopied1{2 "delist_info": {3 "delist_time": "2024-06-15T14:30:00Z",4 "delisted_by_user_id": "550e8400-e29b-41d4-a716-446655440000"5 }6}