Response Properties | Policy Request Status

HTTP Status = 200

Property	Type	Description	Nullable
`connection_id`	String	Unique identification for each policy request.	No
`placement_id`	String	Id of Fize modal in the application. Eg; placement_1	No
`setup_id`	String	Id of policy sync link.	Yes
`insurance_line`(Insurance Line)	Enum	Insurance line of current policy sync.	No
`code` (Policy Sync Status Code)	Enum	Policy sync status code value. This code can be utilized to take further action/decision as it provides the current status of policy sync.	Yes
`message` (Policy Sync Status Code)	Enum	Policy sync status message value.	Ye

Examples

code = SUCCESS

{
    "connection_id": "ci_7909eff6def443=",
    "placement_id": 2,
    "setup_id": null,
    "insurance_line": "personal",
    "code": "SUCCESS",
    "message": "At least one policy with a declaration page is available."
}

HTTP Status = 204

In this, there will be no content in response which means policy sync is in progress.

Examples

Policy Sync In Progress

// No content in response

HTTP Status = 403

Here API endpoint or header used by the client is invalid and needs to be corrected according to the documentation

Property	Type	Description
`message`	String	Message value.

Examples

Invalid API Endpoint/Method

{
  "message": "Missing Authentication Token"
}

HTTP Status = 400

Here either some required parameters are missing in the API request or provided details are invalid.

Property	Type	Description	Nullable
`code` (Common Status Code)	Enum	Invalid request message code.	No
`message`	String	Invalid request message value. It includes provided detail in the request is invalid or could be required API request details are not provided.	No

Examples

Missing Required Details In API Request

{
    "code": "INVALID_REQUEST",
    "message": "Missing required details in API request: client_id, client_secret_key, connection_id"
}

HTTP Status = 401

Here either the client details provided are not correct or the client is not valid.

Property	Type	Description	Nullable
`code`(Common Status Code)	Enum	Invalid request message code.	No
`message`	String	Invalid request message value. It includes provided detail in the request is invalid or could be required API request details are not provided.	No

Examples

Client Details Are Invalid In API Request

{
    "code": "INVALID_AUTH",
    "message": "Provided client_secret_key or client_id or both are invalid. Please contact us at [email protected] to get the valid client_id and client_secret_key"
}

HTTP Status = 500

Here API getting an internal server issue. In this case, the user can retry the API call request.

Property	Type	Description	Nullable
`code`(Common Status Code)	Enum	Internal server error code.	No
`message`	String	Internal server error message value.	No

Examples

Internal Server Error from API

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Something went wrong at our end. Please try again or contact us at [email protected]"
}