API Documentation

 1. Getting Started

  • If you are responsible for creating online presence for small businesses and creating large number of business profiles on our website, our APIs can make your life much easier.
  • You need to obtain API key before you can start using EnrollBusiness APIs. And in order to get the Key, you need to be Registered user.

 2. Obtain API Key

1. Register User

First you need to register user. If you are new user, click : Register User. If you are existing user, just Login.

2. Get API Key

Once you are logged in with your Email and Password, go to MyAccount. In MyAccount screen, click on "For Developers" menu item as shown in the following screenshot. And Click "Generate API Key" button.

Once API key is generated it should appear as shown in the following screenshot. You are now all set to make EnrollBusiness API calls.

 3. Create Business Profile API

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?ApiKey={YOUR_API_KEY}

HTTP Headers

You must specify following HTTP Headers when making API call:

  • content-type: application/json
  • Referer: https://EnrollBusiness.com

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 [Optional] : 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.
  • BusinessName [Mandatory] : Name of the business.
  • OwnerName [Optional] : Name of the business owner.
  • 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 [Optional] : 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.
  • AcceptedPaymentMethods [Optional] : These are the various payment methods the business accepts when dealing with monetary transactions. Valid values are : Cash, DebitCard, CreditCard, Cheque, Paypal and MoneyOrder

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 query string parameter is not provided in URL 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."
        }
        
        

 4. Transfer Ownership API

If you have created business profile on someone else's behalf and you want to transfer ownership of the profile to actual owner, so that they can manage their profile using own credentials, use this API.

Endpoint

PUT https://enrollbusiness.com/Api/Profile/Transfer/Ownership/en?ApiKey={YOUR_API_KEY}

HTTP Headers

You must specify following HTTP Headers when making API call:

  • content-type: application/json
  • Referer: https://EnrollBusiness.com

Request Body

      
      {
	      "ProfileID" : 678,
	      "TransferToEmail" : "example@gmail.com",
	      "TransferToActivationKey" : "54e21542b760d5.49829155",
      }
      
    
  • ProfileID [Mandatory] : Numeric ID of the Profile that you want to transfer to another account. When you call Create Business Profile API, you should have got ProfileID as part of the success response.
  • TransferToEmail [Mandatory] : Email Address of the User to which you want to transfer ownership of the Profile. Please note that the user to which you are transferring ownership must be registered and activated user.
  • TransferToActivationKey [Mandatory] : Activation Key of the User to which you want to transfer ownership of the Profile. As shown in the screenshot below, Activation Key can be found from My Account User Profile screen.

Response

Success Response:

Once successful the response returns HTTP Status Code: 200. Response Body will look like this.

        
        {
          "ResultCode":1,
          "Message":"Ownership of the profile transferred successfully."
        }
        
        

Error Response:

HTTP Status Code: 401 Unauthorized:

If APIKey query string parameter is not provided in URL 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":
          {
            "TransferToEmail":"Invalid EmailID. Valid example is example@gmail.com"
          }
        }
        
        

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."
        }