17 PureFI Claim API and Contract API (REST)
PureFI Claim API and Contract API#
Overview#
This documentation provides technical details for SEFI’s Rest Claim API for pureFI™ which includes “Contract” and” Claim” endpoints which allow searching for contracts, submitting claims and retrieving claim data. The API will verify all the business rules necessary to execute the transaction, and if these are met it will execute the transaction. If any business rules are not met the API will specify these in error/warning responses.Technical documentation#
To execute the API, user must go on the link below and choose the operation which needs to be executed by entering TPA code and required fields to get the expected the results.Contract API for pureFI™#
Provides the ability to search for a contract either by “TPA code & Contract#” or by “TPA Code & VIN & Customer information.”It returns basic information such as Contract type, Expiration Date, Odometer Expiration, Status, etc. | |
|---|
| Operation | Description |
| GET /{tpa}/contracts | Search contracts |
| GET /{tpa}/contracts/{contract} | Retrieve data for a specified contract number |
Claim API for pureFI™#
Provides the ability to retrieve claims and submit Claim Header information to create new claims. | |
|---|
| Operation | Description |
| GET /{tpa}/claims | Search claims |
| PUT /{tpa}/claims | Creates new claim and updates claim header |
| GET /{tpa}/claims/{claim} | Retrieves data for a specified claim number |
Note: Claim API for pureFI™ does NOT has the ability to submit job details, Payee and Claim documents to fulfill the claim requirements.Credentials#
SEFI uses JTW based bearer token authentication. Credentials should be requested from your account managers. You will receive a Client ID and a Client Secret.Client id will look similar to: “AAA|apiuser|20181219|B9816AAAB2222D2D6106D01” In this example:AAA: is the TPA code for which the credentials are valid
apiuser: is the user id that needs to be setup in SCS (Prod and UAT) with the correct permissions such as the ability to add claims or view contracts
The remaining string is needed for validation
POST /login/connect/token/ HTTP/1.1
Content-Type: multipart/form-data;
Content-Disposition: form-data; name="client\_id" AAA|apiuser|20181219|B9816AAAB2222D2D6106D01
Content-Disposition: form-data; name="client\_secret" C2D65B3FF0B56C2312D9A7A2C559680A310B0CE6C2842BFE80E5A47BFCC9
Content-Disposition: form-data; name="grant\_type" client\_credentials
Content-Disposition: form-data; name="scope" Claim Contract ScsPermission
**{**
**"access\_token": "token\_would\_be\_here", "expires\_in": 86400,**
**"token\_type": "Bearer"**
**}**
**POST /v1/{tpa}/claims HTTP/1.1 Content-Type: application/json**
**Authorization: Bearer token\_would\_be\_here**
**{**
**"lossOdometer": "1000",**
**"lossDate": "2010-01-01",**
**"contract": {**
**"number": "111"**
**}**
**}**
Swagger Validation#
SEFI’s pureFI Rest APIs are documented using Swagger which in addition to providing the request and response JSON formats and requirements allows testing of credentials and executing the API calls.Navigate to Swagger, links above
In the dialog enter the Client Id, the Client Secret, and select the scope.
Click Authorize
If the credentials are valid for that environment and user id, you will receive the following. At this point, Swagger has a token that is valid for executing the API calls
Click on the line with the API call:
After the section expands, click on “Try it out”
Enter the TPA code and the remaining required information (varies by API call)
You will see the complete API URL call (Request URL) and the Server Response, including errors that may occur
Modified at 2026-09-08 21:57:11
