This section outlines basic details of Fize API endpoints and connection. It includes information about parameters required by the API's to yield a response. It also outlines basic definitions of the response codes with respect to HTTP request and the policy data.
Fize API endpoints are listed below.
|/policies/status||API to fetch the status of the policy request. It gives status per request.|
|/policies||API endpoint to return data of policies for a policy request made from the client side.|
|/policies/basic||API endpoint to return a list of policies with the structure of the basic policy in policies.|
|/policies/holder||API endpoint to return a list of policies with the structure of the policy holder in policies.|
|/policies/documents||API endpoint to return a list of policies with the structure of the policy documents in policies.|
|/policies/discount||API endpoint to list all the discounts applied for the policy|
|/policies/detail||API endpoint to return policy-details section for a policy record|
For each request of the policy data, a unique key is assigned to represent the whole data across the Fize domains. It is 16 characters in length and needs to be included within the HTTP request made to an endpoint. Within the request, this is defined as
Fize platform is multi-tenant platform that acquire the policy data. To retrieve the policy data for further consumption, Fize requires the information of the client with which the data is acquired. Each client is identified on the basis of 2 parameters for each endpoint request.
For the sync APIs, these are part of the HTTP Request Body and the Authorization key names for the Sync API Endpoints are:
Similarly for the Incremental API endpoints, these are part of the request header with following names:
The Client ID's "
client_id" and Secret Keys "
client_secret_key" will be provided during onboarding with Fize.
client_secret_keyensures that a clients are authorised to use the Fize REST API.
Fz-Client-Secret-Keywill be hosted on your backend service and be treated as a password. It should not to be shared with unauthorised parties.
These status codes will come in response to the Policy APIs' response.
|Code||HTTP Code||Possible Reason|
|400||- Invalid |
- If the data send in headers or body is not proper.
|401||Not authorized to access the data for this connection_id.|
|202||Fize system's data acquiring process is in progress and currently the specified client is validating account credentials.|
|400||Request is not processed due to a login failure by an incorrect credential.|
|500||Something went wrong while processing the API request.|
Policy Status is used to show the status of async pulling for policy requests.
|202||Data request will process soon.|
|202||Data request is in process and will be ready soon to consume.|
|200||Data request is partially completed. Acquired data can be fetched if this status is received.|
|200||Data request is completed. Complete data for the respective section is available and ready to consume.|
|400||Data for this section was not requested.|
|400||Data is not available for that section.|
|500||Data Request failed.|