Pre-requisites

First Orion Branded Communications agreement
Access to First Orion Customer Portal
Vetted and Approved Organization
Understanding of First Orion's Authentication Endpoint
Tool/Service to invoke API Endpoints (cURL examples shown here)
Lab Access (optional)

Understanding Organization vs Business Level

Organization Organizations have the ability to register and manage businesses.

Business Level Businesses have the ability to register phone numbers.

Access Organizations can manage businesses and business phone numbers in the Customer Portal or with their API keys. Businesses can only manage the phone numbers in their own business.

Data Hierarchy

One Organization can manage multiple Businesses. One Businesses can manage multiple phone numbers.

Lab Environment

First Orion has a Lab Environment to test integrations. Check this page out for more information.

Register and update Businesses

Business Data Breakdown

First Orion allows a business to be registered using one API call, that should include all needed business information to get approved. To update an existing business, specific API calls will need to be used for the specific data object. See below.

Data breakdown

For a breakdown of each body parameter, see the body parameter section on this page.

{
  "dba": "First Orion",
  "demographics": {
       "employeeCountRangeId": 3,
       "industryId": 7
     },
  "dunsNumber": "",
  "legalName": "First Orion",
	"numberProviders": [
    "Allstream",
    "Comcast"
  ],
  "primaryPhoneNumber": "+15013584061",
  "website": "firstorion.com",
	"taxId": "12-3456789"
}

{
	"city": "North Little Rock",
  "countryCode": "US",
  "postalCode": "72114",
  "streetAddress1": "520 Main St"
}

{
  "contactName": "John Smith",
  "email": "[email protected]",
	"phoneNumber": "+15013584061"
}

{
  "exceptionsToBlocklist": [
    "fraud",
    "scam"
  ],
  "serviceGrants": [
		"CT"
	]
}

{
     "addresses": [
          {
               "city": "North Little Rock",
               "countryCode": "US",
               "postalCode": "72114",
               "primaryLocation": true,
               "state": "AR",
               "streetAddress1": "520 Main St"
          }
     ],
     "administrativeContacts": [
          {
               "contactName": "John Smith",
               "email": "[email protected]",
               "phoneNumber": "+15013584061"
          }
     ],
     "context": {
          "exceptionsToBlocklist": [
               "fraud",
               "scam"
          ],

          "serviceGrants": [
               "CT"
          ]
     },
     "dba": "First Orion",
     "demographics": {
          "employeeCountRangeId": 3,
          "industryId": 7
     },
     "dunsNumber": "",
     "legalName": "First Orion",
     "primaryPhoneNumber": "+15013584061",
     "tfaDeliveryMethod": "call",
     "website": "firstorion.com",
     "taxId": "12-3456789"
}

API Endpoints

Update Business - Updates the business information for a specific business. Use Business Info Body example.

Update Business Address - Updates the address for a specific business. Use Address Body example.

Update Business Contact - Updates the main contact for a specific business. Use Admin Contact Body example.

Update Business Context - Updates the context for a specific business. Use Business Context Body example.

Business Vetting

Please provide complete and accurate data about your business to reduce processing and vetting time. If the information you provide is incorrect, business vetting time could take up to 3-5 business days. Based on the data provided a business will be placed in the following status:

APPROVED
UNDER_REVIEW
PENDING
REJECTED

Reduce Vetting Time

The following data elements provided will reduce processing and vetting time and should be considered required for appropriate business vetting:

Legal Business Name
Primary phone number
Street address
City
State
Zip
Industry
Employee count
Primary contact name
Primary contact email
Primary contact phone number

The following fields are considered recommended and can reduce processing and vetting time:

DBA
Website URL
Tax ID
Duns Number

Next Steps

After the business is approved, the next step is to add phone numbers. See detailed guide Phone Number Management for more info.

Create Phone Number

Endpoint Page

curl --request POST \
     --url https://api.firstorion.com/exchange/v1/businesses/719d140e-fd6c-4d59-9241-3dee71b38320/phone-numbers \
     --header 'Authorization: token string' \
     --header 'Ccontent-Type: application/json' \
     --data '
[
  {
    "callPurposeCode": "CS",
    "phoneNumber": "+12125554200"
  }
]
'

Delete Phone Number

Note: There are multiple ways to delete phone numbers from a business, this is the recommend way. Endpoint Page

curl --request POST \
     --url https://api.firstorion.com/exchange/v1/businesses/719d140e-fd6c-4d59-9241-3dee71b38320/phone-numbers/DELETE \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "phoneNumbers": [
    "+12125554200"
  ]
}
'

Business Registration API Guide