Documentation

POST /policySearch

post
https://app.usecanopy.com/api/v1.0.0/teams//policySearch

Initiates a new credential-less insurance policy search. Supports Auto insurance policy search, Home insurance policy search, and Auto ID Card search.

Path Params
uuid
required

ID of the requesting Team

Body Params
string
required

User's IP address or other unique end user identifier.

integer
required

Must correspond to the terms_version that was presented to the user.

string
required
length ≤ 1024

Text that was displayed to the user when prompting for their consent.

string
required

The widget alias that the pull will be submitted on.

string
enum
required

Carrier ID to search for policies

Allowed:
string
enum
required

Type of search. Supply "AUTO_ID_CARD" for Auto ID Card Search, "AUTO_POLICY" for Auto Policy Search, and "HOME_POLICY" for Home Policy Search

Allowed:
searchData
object
required

Key/value pairs corresponding to carrier-specific input requirements

Responses

Updated 4 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago