APIs for Claims Management
The UPS Capital Insurance Coverage API allows customers to quote, purchase, and confirm insurance coverage for their transactional shipments. Required insurance data will be transmitted between the customer’s user interface to the UPS Capital network.
Introduction to Claims API
Description
The API’s purpose is to allow customers to submit claim information and retrieve claim status. The customer receives a unique token with certain customer credentials generated by UPSC for enabling communication between provider (UPS Capital) and consumer (Customer). The customer will also receive an IBM Client ID and IBM Client Secret from UPSC.
Create Claim API
Customers can create a claim by providing the required information.
Upload Document API
This API allows for the customer to upload required claim documents to an existing claim. The customer must build the parameter to limit document size to 5MB or less to successfully pass.
Getting Started with Claims API
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 Claim API
POST
https://upscapi-rzd.ams1907.com/apis/list-extstg/v2/claimsThis method creates a claim.
Upload Document API
POST
https://upscapi-rzd.ams1907.com/apis/list-extstg/v1/claims/uploadDocumentThis method allows the customer to upload documents for an existing claim.
How to Integrate with Claims API
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.
Claims API Reference
For more detailed documentation, click here to view our full claims API Documentation
Create Claim 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.