revision_history

get_revision_history

POST

/api/v2/revision_history/get_revision_history

Code
Get revision history for a policy with premium comparisons.

Args:
    policy_id (str): The policy ID

Returns:
    dict: Serialized revision history response

get_revision_history › Request Body

Request schema for /api/v2/revision_history/get_revision_history

request-get_revision_history

api_key

string · required

API key for authentication

policy_id

string · uuid · required

Policy ID to retrieve revision history for

get_revision_history › Responses

200

Response schema for /api/v2/revision_history/get_revision_history

response-get_revision_history

object · required

Revision history for the requested policy

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/revision_history/get_revision_history

curl --request POST \
  --url /api/v2/revision_history/get_revision_history \
  --header 'Content-Type: application/json' \
  --data '
{
  "api_key": "api_key",
  "policy_id": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "api_key": "api_key",
  "policy_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "data": {
    "revisions": [
      {
        "id": "id",
        "effective_date": "2024-08-25",
        "revision_date": "2024-08-25",
        "commit_date": "2024-08-25",
        "current_premium": "current_premium",
        "previous_premium": "previous_premium",
        "premium_diff": "premium_diff",
        "coverages": [
          {
            "name": "name",
            "property_name": "property_name",
            "current_premium": "current_premium",
            "previous_premium": "previous_premium",
            "premium_diff": "premium_diff"
          }
        ]
      }
    ]
  },
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

return_premium rules