Skip to content

Create Business Profile

Create a new business profile for a user.

This endpoint creates a new business profile for a specific user. It allows setting business identification details and contact information.

Endpoint

MethodUrl
POST/v1.0/users/:user_id/business-profile

Path Parameters

user_id
string
required

The unique identifier of the user for whom to create the profile.

Request Body

owner_user_id
string

ID of the user that will own the profile. If not provided, defaults to the user_id from the path.

business_info
object
required

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

contact_info
object

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

Sample Request

Copied
1curl -X POST 'https://api.worklayer.com/v1.0/users/3b31f309-93ad-463a-ad1d-c39cac1c0a3d/business-profile' \
2-H 'Authorization: Bearer {token}' \
3-H 'Content-Type: application/json' \
4-d '{
5 "business_info": {
6 "business_name": "Acme Corporation",
7 "date_of_incorporation": "01/01/2020",
8 "employer_identification_number": "12-3456789"
9 },
10 "contact_info": {
11 "email": "contact@acme.com",
12 "phone_number": "+1-555-555-5555",
13 "address": {
14 "address_line_1": "123 Business Ave",
15 "address_line_2": "Suite 100",
16 "city": "Miami",
17 "region": "FL",
18 "postal_code": "33134",
19 "country": "United States"
20 }
21 }
22}'

Response

id
string

Unique identifier of the created profile.

version
integer

Version number of the created profile.

Sample Response

Copied
1{
2 "id": "550e8400-e29b-41d4-a716-446655440000",
3 "version": 1
4}

Errors

  • 400: Invalid request body
  • 403: You're not allowed to create the profile
  • 404: User not found
Last updated on December 9, 2024