This API Creates a new Business Profile. It does not update the existing one. The profile is created under the ownership of the user who owns API Key. If you are creating business profile for someone else and you want to transfer the ownership of the profile later on, please refer to this API : Transfer Ownership API
Endpoint
POST https://enrollbusiness.com/Api/Profile/en
HTTP Headers
You must specify following HTTP Headers when making API call:
- content-type: application/json
- Referer: https://EnrollBusiness.com
- APIKey: {YOUR_API_KEY}
Note: To know how to obtain API Key, Please refer to Getting Started page.
Request Body
{
"Address": {
"StreetAddress1": "425 Turnberry Ct.",
"StreetAddress2": "",
"CityName": "Bear",
"StateName": "Delaware",
"CountryISOCode": "US",
"PostalCode": "19701"
},
"PhoneNumbers": [
{
"Type": "Phone",
"Number": "302-778-7676"
},
{
"Type": "Cell",
"Number": "302-778-5559"
},
{
"Type": "TollFree",
"Number": "800-778-7676"
}
],
"BusinessName": "Magic Shoes Inc.",
"OwnerName": "Mr. Dave Williamson",
"Websites": [
"http://example.com",
"https://plus.google.com/example",
"https://www.youtube.com/watch?v=7yrSNW2tEnU"
],
"IndustryGroups": [
"Shoe Store",
"Footwear Shop"
],
"AboutBusiness": "Ours is a shoe retail store located in Christiana Mall, Delaware. We have all major brand footwears for all sizes and modern patterns.",
"WorkingHours": [
{
"Day": "Monday",
"24Hours": "false",
"OpeningTime": "09:15",
"ClosingTime": "20:00"
},
{
"Day": "Tuesday",
"24Hours": "false",
"OpeningTime": "09:15",
"ClosingTime": "20:00"
},
{
"Day": "Wednesday",
"24Hours": "false",
"OpeningTime": "09:15",
"ClosingTime": "20:00"
},
{
"Day": "Thursday",
"24Hours": "false",
"OpeningTime": "09:15",
"ClosingTime": "20:00"
},
{
"Day": "Friday",
"24Hours": "false",
"OpeningTime": "09:15",
"ClosingTime": "20:00"
},
{
"Day": "Saturday",
"24Hours": "true"
}
],
"AcceptedPaymentMethods": [
"Cash",
"DebitCard",
"CreditCard"
]
}
-
Address [Mandatory] : is address of the business location. It's an object containing following fields
- StreetAddress1: First line of the Street Address.
- StreetAddress2: Second line of the Street Address.
- CityName: Name of the City. Please use our lookup tool to find out City Name: Address Lookup
- StateName: Name of State, Province or County.
- CountryISOCode: Country's ISO code. Please see all countries ISO Codes here : https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
-
PhoneNumbers [Mandatory] : is a list of contact numbers (Phone, Cell, TollFree and Fax), maximum up to 6. It's an array of objects containing following fields
- Type: Valid types are Phone, Cell, TollFree and Fax.
- Number: Contact number like 1-800-787-9898.
Note: If you don't want to specify Phone Numbers, just pass empty Array like this - "PhoneNumbers" : []
- BusinessName [Mandatory] : Name of the business.
- OwnerName [Optional] : Name of the business owner.
-
Websites [Mandatory] : is a list of business websites, maximum up to 6. It's an array of valid website URLs.
Note: If you don't want to specify Websites, just pass empty Array like this - "Websites" : []
- IndustryGroups [Mandatory] : is an array of Industry Groups (up to 6) the business belongs to. E.g., Restaurant, Music Lessons, Electronic Shop etc. Please use our lookup tool to find out appropriate Industry Category: Industry Group Lookup
- AboutBusiness [Mandatory] : Detailed description of the business at least in 120 characters.
-
WorkingHours [Mandatory] :
Working Hours of the business. It's an object containing following fields:
- Day: Day of the Week. E.g., Sunday, Monday, Tuesday etc.
- 24Hours: It can have either True or False values indicating whether the business is open for 24 hours on this day. If this value is True, values for OpeningTime and ClosingTime will be ignored.
- OpeningTime: is the Time at which business opens. It accepts 24 hour time format with 15 minutes intervals. Some examples of valid OpeningTime are : 7:00, 9:15, 8:30, 13:45 etc. The value of this field must be earlier than ClosingTime. If the value of 24Hours is False, you must specify valid value for this field.
- ClosingTime: is the Time at which business closes. It accepts 24 hour time format with 15 minutes intervals. Some examples of valid ClosingTime are : 18:15, 19:30, 20:45, 23:00 etc. The value of this field must be later than OpeningTime. If the value of 24Hours is False, you must specify valid value for this field.
Note: If you don't want to specify Working Hours, just pass empty Array like this - "WorkingHours" : []
-
AcceptedPaymentMethods [Mandatory] :
These are the various payment methods the business accepts when dealing with monetary transactions. Valid values are : Cash, DebitCard, CreditCard, Cheque, Paypal and MoneyOrder
Note: If you don't want to specify Payment Methods, just pass empty Array like this - "AcceptedPaymentMethods" : []
Response
Success Response:
Once successful the response returns HTTP Status Code: 200. Response Body will look like this. It will have ProfileID field with the value of newly created business profile.
{
"ResultCode":1,
"Message":"Your Business Profile has been created successfully !",
"ProfileID":1234
}
Error Response:
HTTP Status Code: 401 Unauthorized:
If APIKey header has not been supplied or it's invalid, the call will return Http Status Code: 401 Unauthorized. Response Body might look like:
{
"ResultCode":5,
"Message":"You are not authorized to perform this operation."
}
HTTP Status Code: 400 Bad Request:
If we are not able to understand the request or some of the values are not valid, the call will return Http Status Code: 400 Bad Request. Response Body might look like:
{
"ResultCode":6,
"Errors":
{
"CountryISOCode":"CountryISOCode is not valid. Valid examples are : 'US' for United States, 'CA' for Canada, 'GB' for United Kingdom etc."
}
}
HTTP Status Code: 500 Internal Server error:
If we are not able process the request for internal processing error, the call will return Http Status Code: 500 Internal Server error. Response Body might look like:
{
"ResultCode":3,
"Message":"Unknown Error occurred. Please try again."
}