Web API Documentation

This Address Validation Management API provides developers a way to validate address information and determine its tax jurisdiction.

The Address Validation Service is used to validate that an address input by a user is valid using USPS, Basic, or CoreLogic.

The Audit Log Management API allows end developers a way to access audit/event log information that is generated by CostGuard Client as well as the CG Web APIs.

The Balance Service is used to create an E-Pay transaction and charge the account at the payment provider in real-time.

The Billing Order Management Service provides a way to update items within a billing order to correspond with various post order submission activities. Examples include PON and Auxiliary Carrier information.

The Bulk Data Management API provides the ability to access information associated to file import requests.

The Catalog Management API provides developers a way to manage their product catalog.

Provides the ability to look up and search for product information for items in the Product Catalog.

The Communications Service allows the ability to send and receive e-mail messages.

The purpose of the customer services is to provide the ability to add, modify, look up, and search for basic customer information.

Provides the ability to find common data values that comprise larger elements throughout CostGuard webservices.

Provides the ability to centrally store, find and download documents that are required for application and business needs.

The Field Service Management API provides developers a way to view and manage the status of the field service system.

Provides the ability to create, view and manage equipment inventories.

Provides the ability to create and modify journal items such as journals, follow-ups, and tickets.

The Location Management API provides developers a way to view and manage location info such as regions, stores, and registers.

The Number Inventory Management API is a RESTful endpoint that allows management of inventoried service numbers.

Provides the ability to find and reserve available service numbers and MINs.

The Order Management API provides developers a way to view and manage orders.

Provides the ability to create a cart with items to be purchased or returned and also to manage the cart through order completion.

The Port Request Management API provides a way to query and update items related to port request activities.

The Provisioning Management API provides developers a way to manage their provisioning system.

This Provisioning API provides developers a way to query and update items related to provisioning activities.

The Rate Bill Management API provides developers a way to manage certain Rating and Billing activities.

This service is used to issue security tokens needed to authenticate with IDI applications and web services.

The Service And Feature Management API is a RESTful endpoint that allows management of assigned services and their features, as well as features assigned at the customer level.

The Tax Management Service offers the ability to calculate taxes for given features at the customer and/or service level. The taxes returned are summarized at the service level.

The primary purpose of the workflow services is to allow relying applications to alter workflow definitions and to facilitate the processing of workflow instances.