APIs for insurance coverage
Integrating digital freight insurance coverage offers all-risk insurance coverage for shipments regardless of carrier or mode
Insurance API for Channel Partners
Introduction to Insurance API (Channel Partner)
Description
The Insurance API’s purpose is to allow customers to receive quotes and confirm insurance coverage for safe and timely package/cargo delivery.
Create Quote API
Customer’s request for a new insurance quote by providing the necessary shipment information.
Purchase Coverage
Customer’s request for confirming shipment for which insurance coverage was previously quoted by providing the necessary coverage information.
Confirm Shipment
Customer’s request for confirming shipment (after being picked up by a transportation carrier) for which insurance coverage was previously purchased by providing the necessary coverage information.
SMB vs Channel Partners
Channel Partner APIs are for larger customers who often have multiple layers of shippers and customers and who ship many different commodities, so pricing can be broken up by commodity. SMB APIs are for smaller customers, usually more direct retail customers, who just want pricing by mode. Click here if you would like to be redirected to the SMB page.
Getting Started with Insurance API (Channel Partner)
This page will help you make requests to the Insurance API using Postman.
Prerequisites
The first step is to ensure all the contractual agreements between UPS Capital (UPSC) and the new customer are completed. Once the agreements are finalized, the UPSC IT API integration team will setup a sandbox environment for the new customer with sample rates to enable the API interactions. The customer IT team will reach out to the UPSC API team for user credentials and other information for enabling secure REST API- based interactions with UPS Capital IT systems.
Create Quote
POST
https://upscapi.ams1907.com/apis/list/quote/v1This method creates a quote in the system for insurance coverage.
Confirm Coverage
POST
https://upscapi.ams1907.com/apis/list/coverage/v1This method places an order for purchasing a previously requested insurance quote.
Confirm Shipment
POST
https://upscapi.ams1907.com/apis/list/shipment/v1This method places the insured shipment picked up by the carrier in a confirmed status and eligible for future claim requests.
How to Integrate with Insurance API (Channel Partner)
Helpful resources
Postman
Postman is a tool you can use to test these APIs. Postman includes every path and parameter in an easy to understand process. Please contact an API specialist from UPSC to forward you a Postman collection. From there, you can see the different methods that the API uses, the URL used to call the API, parameters the API is expecting from your call, headers used in the call to the API, the body of the API, among other important details that will be related to testing and implementation.
When trying to implement/test your API, you will need to contact an API specialist to give you an X-IBM Client ID and a bearer token in order to start making calls to the API. In order to test the API call on Postman, you will need to either receive a valid sample request for GET methods, or proper parameters and a filled out body for POST requests.
NOTE:
It is advised to test APIs with GET methods since POST methods add data to a database.
Authentication
UPS Capital APIs use secure JWT tokens for service authentication. Any calls to the REST API endpoint should be made bearer tokens in the request headers in addition to using the secured JWT tokens provided by the UPS Capital API Integration team.
During the customer onboarding process, the customer procures a unique Secure Token with certain customer credentials generated by the API Integration team for enabling communication between provider (UPS Capital) and consumer (Customer). The customer will also receive an IBM Client ID and IBM Client Secret from the UPS Capital API Integration team. These security features are placed in the header of each API call, along with the customer’s bearer token.
Insurance API (Channel Partner) Reference
For more detailed documentation, click here to view our full Insurance API Documentation
Create Quote API
Request Parameters
This details what kind of parameters the API is expecting when you call the API.
Request Parameters
body * (required)
Quote object needs to be sent to the API as a request payload…
Request Headers
Content-Type : application/json
Bearer : < secure token issued by API integration team >
X-IBM-Client-Id : <provided by API integration team>
X-IBM-Client-Secret : <provided by API integration team>
Model:
Quote
statusString
Indicates status of the package that is being insured by the customer.
partnerIDString
Required
Indicates assigned Partner Id of customer.