1. Create business profile
POST {{host}}/v1/profiles
| Field | Description | Format | Validation Rules (java regex) |
|---|---|---|---|
| type | business | Text | Always business |
| details.name | Business name | Text | Must not contain: %#^@{}"!~<>\. ((^[^%#^@{}"!~<>\\]+$)) |
| details.registrationNumber | Business registration number | Text | 1 to 30 characters. |
| details.acn | Australian Company Number (only for Australian businesses) | Text | Must be valid ACN. |
| details.abn | Australian Business Number (only for Australian businesses) | Text | Must be valid ABN. |
| details.arbn | Australian Registered Body Number (only for Australian businesses) | Text | Must be valid ARBN. |
| details.companyType | Company legal form. Allowed values:
| Text | Must be one of the enum values. |
| details.companyRole | Role of person. Allowed Values:
| Text | Must be one of the enum values. |
| details.descriptionOfBusiness | Sector / filed of activity (DEPRECATED) | Text | Deprecated, use businessCategory and set this as null. |
| details.webpage (conditional) | Business webpage. Required if companyType is OTHER | Text | Valid URL. (^(?i)\\b(https?://)?((?=[a-z0-9-]{1,63}\\.)[a-z0-9]+(-[a-z0-9]+)*\\.)+[a-z]{2,63}\\b(/.*)*$) |
| details.businessCategory | Type of business, see below for permitted values | Text | One of the below Business Category values. |
| details.businessSubCategory | Specific sub category of the business type, see below for permitted values | Text | A valid subcategory of the selected businessCategory. |
Business Category
Ensure when submitting a business profile that you submit a category and associated sub-category from the list below. You should map from the information you have about the business to one of our categories and sub-categories. If this is problematic please get in touch with us to discuss alternate solutions.
The categories and their sub-categories are as follows:
- CHARITY_NON_PROFIT
- CHARITY_ALL_ACTIVITIES
- CONSULTING_IT_BUSINESS_SERVICES
- ADVERTISING_AND_MARKETING
- ARCHITECTURE
- COMPANY_ESTABLISHMENT_FORMATION_SERVICES
- DESIGN
- FINANCIAL_CONSULTING_ACCOUNTING_TAXATION_AUDITING
- IT_DEVELOPMENT
- IT_HOSTING_SERVICES
- IT_CONSULTING_AND_SERVICES
- LEGAL_SERVICES
- MANAGEMENT_CONSULTING
- SCIENTIFIC_AND_TECHNICAL_CONSULTING
- SOFTWARE_AS_A_SERVICE
- TRANSLATION_AND_LANGUAGE_SERVICES
- CONSULTING_OTHER
- SERVICES_OTHER
- FREELANCE_PLATFORMS
- RECRUITMENT_SERVICES
- MAINTENANCE_SERVICES
- FREELANCE_PLATFORMS
- DESIGN_MARKETING_COMMUNICATIONS
- ADVERTISING_AND_MARKETING
- ARCHITECTURE
- AUDIO_AND_VIDEO
- DESIGN
- PHOTOGRAPHY
- PRINT_AND_ONLINE_MEDIA
- TELECOMMUNICATIONS_SERVICES
- TRANSLATION_AND_LANGUAGE_SERVICES
- MEDIA_COMMUNICATION_ENTERTAINMENT
- ADULT_CONTENT
- AUDIO_AND_VIDEO
- FINE_ARTS
- ARTS_OTHER
- EVENTS_AND_ENTERTAINMENT
- GAMBLING_BETTING_AND_ONLINE_GAMING
- NEWSPAPERS_MAGAZINES_AND_BOOKS
- PERFORMING_ARTS
- PHOTOGRAPHY
- TELECOMMUNICATIONS_SERVICES
- VIDEO_GAMING
- EDUCATION_LEARNING
- SCHOOLS_AND_UNIVERSITIES,
- TEACHING_AND_TUTORING
- ONLINE_LEARNING
- FINANCIAL_SERVICES_PRODUCTS_HOLDING_COMPANIES
- CROWDFUNDING
- CRYPTOCURRENCY_FINANCIAL_SERVICES
- FINANCIAL_CONSULTING_ACCOUNTING_TAXATION_AUDITING
- HOLDING_COMPANIES
- INSURANCE
- INVESTMENTS
- MONEY_SERVICE_BUSINESSES
- FINANCIAL_SERVICES_OTHER
- FOOD_BEVERAGES_TOBACCO
- ALCOHOL
- FOOD_MANUFACTURING_RETAIL
- RESTAURANTS_AND_CATERING
- SOFT_DRINKS
- TOBACCO
- VITAMINS_AND_DIETARY_SUPPLEMENTS
- HEALTH_PHARMACEUTICALS_PERSONAL_CARE
- HEALTH_AND_BEAUTY_PRODUCTS_AND_SERVICES,
- DENTAL_SERVICES,
- DOCTORS_AND_MEDICAL_SERVICES,
- ELDERLY_OR_OTHER_CARE_HOME,
- FITNESS_SPORTS_SERVICES,
- MEDICAL_EQUIPMENT,
- NURSING_AND_OTHER_CARE_SERVICES,
- PHARMACEUTICALS,
- PHARMACY,
- VITAMINS_AND_DIETARY_SUPPLEMENTS
- PUBLIC_GOVERNMENT_SERVICES
- PUBLIC_ALL_SERVICES
- MAINTENANCE_SERVICES
- GOVERNMENT_SERVICES
- TELECOMMUNICATIONS_SERVICES
- UTILITY_SERVICES
- REAL_ESTATE_CONSTRUCTION
- ARCHITECTURE
- CONSTRUCTION
- REAL_ESTATE_DEVELOPMENT
- REAL_ESTATE_SALE_PURCHASE_AND_MANAGEMENT
- RETAIL_WHOLESALE_MANUFACTURING
- AGRICULTURE_SEEDS_PLANTS
- FINE_ARTS
- ARTS_OTHER
- AUTOMOTIVE_SALES_SPARE_PARTS_TRADE
- AUTOMOTIVE_MANUFACTURING
- CHEMICALS
- CLOTHING
- ELECTRICAL_PRODUCTS
- FIREARMS_WEAPONS_AND_MILITARY_GOODS_SERVICES
- HOME_ACCESSORIES_FURNITURE
- FINE_JEWELLERY_WATCHES
- FASHION_JEWELLERY
- HEALTH_AND_BEAUTY_PRODUCTS_AND_SERVICES
- LEGAL_HIGHS_AND_RELATED_ACCESSORIES
- MACHINERY
- PETS
- PRECIOUS_STONES_DIAMONDS_AND_METALS
- SPORTING_EQUIPMENT
- MANUFACTURING_OTHER
- RETAIL_WHOLESALE_MARKETPLACE_AUCTION
- RETAIL_WHOLESALE_OTHER
- TOYS_AND_GAMES
- TRAVEL_TRANSPORT_TOUR_AGENCIES
- ACCOMMODATION_HOTELS
- PASSENGER_TRANSPORT
- FREIGHT_TRANSPORT
- RIDESHARING_TRANSPORT_SHARING_SERVICES
- TRANSPORT
- TRAVEL_AGENCIES
- TOUR_OPERATORS
- TRAVEL_OR_TOUR_ACTIVITIES_OTHER
- OTHER
- OTHER_NOT_LISTED_ABOVE
Request Body
{"type"=>"business", "details"=>{"name"=>"{{$randomCompanyName}}", "registrationNumber"=>"12144939", "acn"=>nil, "abn"=>nil, "arbn"=>nil, "companyType"=>"LIMITED", "companyRole"=>"OWNER", "webpage"=>"{{$randomUrl}}", "businessCategory"=>"CONSULTING_IT_BUSINESS_SERVICES", "businessSubCategory"=>"DESIGN"}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string | ||
Content-Type | string |
RESPONSES
status: OK
"{\n \"id\": {{business-profile-id}},\n \"type\": \"business\",\n \"details\": {\n \"name\": \"ABC Logistics Ltd\",\n \"registrationNumber\": \"12144939\",\n \"acn\": null,\n \"abn\": null,\n \"arbn\": null,\n \"companyType\": \"LIMITED\",\n \"companyRole\": \"OWNER\",\n \"descriptionOfBusiness\": \"DESIGN\",\n \"primaryAddress\": 37034385,\n \"webpage\": \"https://abc-logistics.com\",\n \"businessCategory\": \"CONSULTING_IT_BUSINESS_SERVICES\",\n \"businessSubCategory\": \"DESIGN\"\n }\n}"