Policy
Get policy by policyCode and email
Changed onReturns a purchased policy if exists. In case the policy was reissued due to a change in the policy, the new policy will be returned as well as its history and any additional traveler information
get/v1/policy/code/{policyCode}/email/{email}
Request
- Base URLhttps://partnerapi.withfaye.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
policyCodestring required
The policy code
emailunknown
Deprecated legacy path parameter. The value is ignored - it can be omitted or set to any value.
Headers
Authorizationstring
Bearer token
Response
Policy found.
Example response
{
"policy": {
"destination": [
{
"country": "US",
"googlePlaceId": "ChIJYYOWXuckZUcRZdTiJR5FQOc",
"state": "CA"
}
]
},
"relatedPolicies": [
{
"destination": [
{
"country": "US",
"googlePlaceId": "ChIJYYOWXuckZUcRZdTiJR5FQOc",
"state": "CA"
}
]
}
]
}Changes
- breaking
added the new path request parameter
email - warning
deleted the
queryrequest parameteremail
- breaking
- warning
deleted the
pathrequest parameteremail - info
added the new optional
headerrequest parameterAuthorization - info
added the new optional
queryrequest parameteremail
- warning