state-farm/collections/state-farm-renters-insurance.opencollection.json at main · api-evangelist/state-farm · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
{
  "opencollection": "1.0.0",
  "info": {
    "name": "State Farm Renters Insurance API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "https://api.statefarm.com/oauth/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Quotes",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create Renters Insurance Quote",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.statefarm.com/v1/renters/quotes",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Request a renters insurance quote for a prospective tenant. Provide the property address, desired coverage amounts, and tenant information to receive a State Farm renters insurance quote with premium details and coverage options."
        },
        {
          "info": {
            "name": "Get Renters Insurance Quote",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.statefarm.com/v1/renters/quotes/:quoteId",
            "params": [
              {
                "name": "quoteId",
                "value": "",
                "type": "path",
                "description": "Unique quote identifier"
              }
            ]
          },
          "docs": "Retrieve details of a previously created renters insurance quote by its ID."
        }
      ]
    },
    {
      "info": {
        "name": "Policies",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Bind Renters Insurance Policy",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.statefarm.com/v1/renters/policies",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Convert an accepted renters insurance quote into a bound policy. This initiates the policy issuance process with State Farm. Requires a valid quote ID and confirmed payment method."
        },
        {
          "info": {
            "name": "Get Renters Insurance Policy",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.statefarm.com/v1/renters/policies/:policyNumber",
            "params": [
              {
                "name": "policyNumber",
                "value": "",
                "type": "path",
                "description": "State Farm policy number"
              }
            ]
          },
          "docs": "Retrieve the status and details of a renters insurance policy by policy number. Returns current coverage, premium, effective dates, and policyholder information."
        }
      ]
    },
    {
      "info": {
        "name": "Coverage",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Coverage Options",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.statefarm.com/v1/renters/coverage-options",
            "params": [
              {
                "name": "state",
                "value": "",
                "type": "query",
                "description": "Two-letter US state code to get state-specific coverage options"
              }
            ]
          },
          "docs": "Retrieve available renters insurance coverage options and limits available through State Farm, including personal property coverage amounts, liability limits, deductible options, and optional add-on coverages."
        }
      ]
    }
  ],
  "bundled": true
}