API docs by Redocly

Odie Insurance Service API (2.0.0)

Download OpenAPI specification:Download

The Odie Insurance Service provides an API for Odie's partners to build white-labelled pet insurance experiences.

File Uploads: The maximum file size for file uploads is 5MB.

Webhooks: A full list of available webhooks can be found at: https://getodie.com/odie-webhooks

Quote

Create or update a quote

Generating a quote for a single pet

Authorizations:
X-API-KEY
Request Body schema: application/json
required

Quote parameters

quoteNumber
string
Default: ""

Fill this to update an existing quote.

effectiveDate
string <date>

The effective date of the future policy. Defaults to tomorrow. Format: YYYY-MM-DD

petName
string

Valid values: a-Z, 0-9, spaces and ,.#$&()?=+-! . Must be filled before checking out

species
required
string
Default: "DOG"

'DOG' or 'CAT'

gender
string
Default: "MALE"

'MALE' or 'FEMALE'. Must be filled before checking out

breedPK
required
string
Default: ""

Breed primary key. Required for INJURY_AND_ILLNESS quotes. Must always be filled before checking out. Breed keys can be found using the Breed endpoint "/api-docs#tag/Breed"

ageKW
required
string
Default: ""

Age keyword list is located here. Required for INJURY_AND_ILLNESS quotes. Must always be filled before checking out.

email
string
Default: "Email will be ignored if userId is set. Either email or userId is required to process a quote."
userId
string

The unique identifier of this user in the Odie system. Either userId or email is required to process a quote.

zipCode
required
string
Default: ""

5-digit state zip code of pet location.

specialDisease
boolean
Default: ""

Does thw pet have a pre-existing condition?

standardAnnualLimit
integer <int32>
Default: ""

Annual Limit. Possible values: 5000, 10000, 25000, 40000. Required for INJURY_AND_ILLNESS quotes. INJURY_ONLY quotes automatically have a 10000 standard annual limit.

coinsurancePercent
integer <int32>
Default: ""

Possible values: 70, 80, 90. Required for INJURY_AND_ILLNESS quotes. INJURY_ONLY quotes automatically have a 90 coinsurance.

deductibleAmount
integer <int32>
Default: ""

Possible values: 50, 100, 150 in “Fifties” up to 1,000. Required for INJURY_AND_ILLNESS quotes. INJURY_ONLY quotes automatically have a 250 deductible.

office_visits
boolean
Default: "false"
home_prescription
boolean
Default: "false"
rehab
boolean
Default: "false"
routine_care
boolean
Default: "false"
routine_care_plus
boolean
Default: "false"
memberFirstName
string
Default: ""

Note this will only be set when requesting the first quote for a new user, existing users are not updated.Valid values: a-Z, 0-9, spaces and ,.#$&()?=+-!. Must always be filled before checking out.

memberLastName
string
Default: ""

Note this will only be set when requesting the first quote for a new user, existing users are not updated. Valid values: a-Z, 0-9, spaces and ,.#$&()?=+-!. Must always be filled before checking out.

webhook
string <uri>

URL of a webhook to call back whenever the policy changes. Use this to notify your users of changes to their policy.

paymentPeriod
string
Default: "Monthly"

The period used to pay, either Monthly or Annual

address_line1
string

Note this will only be set when requesting the first quote for a new user, existing users are not updated. Valid values: a-Z, 0-9, spaces and ,.#$&()?=+-!. Must always be filled before checking out.

address_line2
string

Note this will only be set when requesting the first quote for a new user, existing users are not updated. Valid values: a-Z, 0-9, spaces and ,.#$&()?=+-!

city
string

Note this will only be set when requesting the first quote for a new user, existing users are not updated. Valid values: a-Z, 0-9, spaces and ,.#$&()?=+-!. Must always be filled before checking out.

shippingZipCode
string

5-digits zip code for shipping address

shippingAddressLine1
string

Note this will only be set when requesting the first quote for a new user, existing users are not updated. Valid values: a-Z, 0-9, spaces and ,.#$&()?=+-!. Must always be filled before checking out.

shippingAddressLine2
string

Note this will only be set when requesting the first quote for a new user, existing users are not updated. Valid values: a-Z, 0-9, spaces and ,.#$&()?=+-!. Must always be filled before checking out.

shippingCity
string

Note this will only be set when requesting the first quote for a new user, existing users are not updated. Valid values: a-Z, 0-9, spaces and ,.#$&()?=+-!. Must always be filled before checking out.

phone
string

Note this will only be set when requesting the first quote for a new user, existing users are not updated. Valid characters: 0-9, spaces and ()+-, should contain exactly 10 digits. Must always be filled before checking out.

planPreference
string
Default: "INJURY_AND_ILLNESS"
Enum: "INJURY_ONLY" "INJURY_AND_ILLNESS"

Choose between two plans. Note - this may not be respected if the pet has a pre-existing illness, in which case the default wlil be INJURY_ONLY plan.

Responses

Callbacks

Request samples

Content type
application/json
{
  • "quoteNumber": "",
  • "effectiveDate": "2019-08-24",
  • "petName": "string",
  • "species": "DOG",
  • "gender": "MALE",
  • "breedPK": "",
  • "ageKW": "",
  • "email": "Email will be ignored if userId is set. Either email or userId is required to process a quote.",
  • "userId": "string",
  • "zipCode": "",
  • "specialDisease": "",
  • "standardAnnualLimit": "",
  • "coinsurancePercent": "",
  • "deductibleAmount": "",
  • "office_visits": "false",
  • "home_prescription": "false",
  • "rehab": "false",
  • "routine_care": "false",
  • "routine_care_plus": "false",
  • "memberFirstName": "",
  • "memberLastName": "",
  • "webhook": "http://example.com",
  • "paymentPeriod": "Monthly",
  • "address_line1": "string",
  • "address_line2": "string",
  • "city": "string",
  • "shippingZipCode": "string",
  • "shippingAddressLine1": "string",
  • "shippingAddressLine2": "string",
  • "shippingCity": "string",
  • "phone": "string",
  • "planPreference": "INJURY_ONLY"
}

Response samples

Content type
application/json:
{
  • "quote": {
    }
}

Callback payload samples

Callback
POST: We callback on this webhook whenever a notifiable
Content type
application/json
{
  • "changeId": "ABCDEFGH",
  • "changeTypes": [
    ],
  • "entity": "Policy",
  • "webhook": "https://myserver.com/send/callback/here",
  • "changeTimestamp": "2021-05-30T15:35:12Z",
  • "charge": {
    },
  • "policy": {
    }
}

Get the list of quotes

Returns a list of quotes for a participant

Authorizations:
X-API-KEY
query Parameters
email
string

Participant email

quoteNumber
string

Quote Number

Responses

Get last quote

Returns the last quote submitted by a participant

Authorizations:
X-API-KEY
query Parameters
email
required
string

Participant email

Responses

Get a single quote

Retrieve a single quote by quote number

Authorizations:
X-API-KEY
path Parameters
quoteNumber
required
string

Quote Number

Responses

Cart

Post a new cart

Create a cart and attach a single quote or an array

Authorizations:
X-API-KEY
Request Body schema: application/json
required
paymentMethod
string
Default: "CREDITCARD"
Enum: "CREDITCARD" "AGENCYBILL" "PAYROLL"
promoCode
string

A coupon code. Alphanumeric string.

userId
string

The unique identifier of this user in the Odie system.

email
required
string <email>

The user's email. Only required if userId is blank.

quoteNumbers
Array of strings

An array of the quote numbers that will be purchased.

Responses

Request samples

Content type
application/json
{
  • "paymentMethod": "CREDITCARD",
  • "promoCode": "string",
  • "userId": "string",
  • "email": "user@example.com",
  • "quoteNumbers": [
    ]
}

Get a cart

Retrieve a single cart

Authorizations:
X-API-KEY
path Parameters
cartId
required
string

The cart id

Responses

Update an existing cart

Update an existing cart

Authorizations:
X-API-KEY
path Parameters
cartId
required
string

The cart id

Request Body schema: application/json
required

Any omitted fields will be left as they were. At least one field must be included.

paymentMethod
string
Default: "CREDITCARD"
Enum: "CREDITCARD" "AGENCYBILL" "PAYROLL"
promoCode
string

A coupon code. Alphanumeric string.

userId
string

The unique identifier of this user in the Odie system.

email
string <email>

The user's email. Only required if userId is blank.

quoteNumbers
Array of strings

An array of the quote numbers that will be purchased.

Responses

Request samples

Content type
application/json
{
  • "paymentMethod": "CREDITCARD",
  • "promoCode": "string",
  • "userId": "string",
  • "email": "user@example.com",
  • "quoteNumbers": [
    ]
}

Purchase/Checkout the cart

Converts the quotes in the cart to policies. All the parameters (payment method, promo codes, etc) are set in the cart. This endpoint simply allows you to finalize the purchase of the cart and convert quotes to policies. Upon purchase, the policy declaration document is generated async, in which you can use the webhook property in the POST /quote endpoint to be notified once the document is ready.

PURCHASING - For Payroll, submit with an empty body. For Credit Card, the body must contain the stripeToken.

Authorizations:
X-API-KEY
path Parameters
cartId
required
string

The cart id

Request Body schema: application/json

Only required if paymentMethod is 'CREDITCARD'. Use the following Stripe documentation to set up the payment form and capture the token. Ask your Odie contact for the publishable keys note that if you are using a sandbox X-API-KEY then Stripe tokens must be generated with the test publishable key for Stripe and vice-versa for live X-API-KEYs. https://stripe.com/docs/payments/accept-a-payment-charges

object

Responses

Request samples

Content type
application/json
{
  • "stripeToken": "tok_1IdLJvDhWLhOvPtTZ6CKVKFf"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "species": "string",
  • "petName": "string",
  • "gender": "string",
  • "discountCode": "string",
  • "discountPercent": 0,
  • "policyNumber": "string",
  • "pet": {
    },
  • "user": {
    },
  • "hasMultiPetDiscount": true,
  • "multiPetDiscountPercent": 0.1,
  • "discountedAnnualPremium": 0,
  • "discountedMonthlyPremium": 0,
  • "annualPremium": 0,
  • "monthlyPremium": 0,
  • "proratedAnnualPremium": 0,
  • "office_visits": true,
  • "home_prescription": true,
  • "rehab": true,
  • "routine_care": {
    },
  • "deductibleAmount": 0,
  • "coinsurancePercent": 0,
  • "standardAnnualLimit": 0,
  • "priceBreakdown": {
    },
  • "webhook": "string",
  • "localTimezone": "string",
  • "policyStartDate": "string",
  • "renewalChangesDeadline": "string",
  • "nextBillingDate": "string",
  • "accidentEffectiveDate": "string",
  • "illnessEffectiveDate": "string",
  • "cruciateEffectiveDate": "string",
  • "policyExpirationDate": "string",
  • "paymentMethod": "CREDITCARD",
  • "documents": [
    ],
  • "plan": "Unexpected Illness and Injuries",
  • "ageKW": "string",
  • "active": "true",
  • "applicationDate": "string",
  • "breedDescription": "string",
  • "breedPK": "string",
  • "paymentPeriod": "string",
  • "quoteNumber": "string",
  • "kyPremTax": 0.1,
  • "kyLocalTax": 0.1,
  • "statePremTax": 0.1,
  • "stateLocalTax": 0.1
}

Policy

Get a single policy

Retrieve a single policy's details by policy number.

Authorizations:
X-API-KEY
path Parameters
policyNumber
required
string

Policy Number

Responses

Add routine care

Add Routine Care or Routine Care Plus to an already existing policy. Effective date will be immediate if Payment Method is Credit Card, otherwise it will be the next billing date.

Authorizations:
X-API-KEY
path Parameters
policyNumber
required
string

Policy Number

Request Body schema: application/json
routineCarePlan
required
string
Enum: "BASIC" "PLUS"

Responses

Request samples

Content type
application/json
{
  • "routineCarePlan": "BASIC"
}

Cancel the policy

Request that the policy is cancelled. This DOES NOT immediately cancel the policy. Odie approval is required prior to cancellation. A callback will be sent to you using the policy's webhook when the cancellation status is changed or updated.

Authorizations:
X-API-KEY
path Parameters
policyNumber
required
string

Policy Number

Request Body schema: application/json
cancellationReason
required
string
Enum: "Pet_Passed" "Too_Expensive" "Switching_Providers" "No_Longer_Needed" "Non_Payment" "Other"
cancellationNote
string

Free text for the user to share more information on why they are cancelling.

Responses

Request samples

Content type
application/json
{
  • "cancellationReason": "Pet_Passed",
  • "cancellationNote": "string"
}

Get prospective cancellation information

Gets the date on which a cancellation would be effective if it were requested now

Authorizations:
X-API-KEY
path Parameters
policyNumber
required
string

Policy Number

Responses

Upload document

Upload a document file to a specific policy number

Authorizations:
X-API-KEY
path Parameters
policyNumber
required
string

The policy to which you want to add a document

Request Body schema: multipart/form-data
document
required
string <binary>

The file to upload. Document upload only supports .jpg, .jpeg, .png, and .pdf filetypes. File requirements are case sensitive.

documentType
required
string
Value: "Medical_History"

The Document type of the uploaded file

Responses

Set Policy Webhook Url

Update policy webhook url

Authorizations:
X-API-KEY
path Parameters
policyNumber
required
string

The policy number for which you want to update webhook

Request Body schema: application/json
webhook
string <uri>

URL of a webhook to call back whenever the policy changes. Use this to notify your users of changes to their policy.

Responses

Request samples

Content type
application/json
{}

Claim

Get a single claim

Returns a single claim

Authorizations:
X-API-KEY
path Parameters
claimNumber
required
string

The claim number

Responses

Get all claims made on a policy.

Returns a list of all claims for the given policy.

Authorizations:
X-API-KEY
path Parameters
policyNumber
required
string

The policy number

Responses

Post a new claim

Create a new claim for the given policy.

Authorizations:
X-API-KEY
path Parameters
policyNumber
required
string

The active policy number based upon the date of service.

Request Body schema: application/json
required

The claim

webhook
string <uri>

URL of a webhook to call back whenever the claim status changes. Use this to notify your users of changes to their claim as it goes through the approval process.

dateOfService
required
string <date>

The date on which the pet received service

category
required
string
Enum: "CLAIMTYPEACCIDENT" "CLAIMTYPEILLNESS" "CLAIMTYPEONGOING" "CLAIMTYPEROUTINE" "CLAIMTYPECLE"

The type of claim, eg for an accident, illness, routine care, cruciate ligament event, or ongoing treatment for a previously submitted claim

amountClaimed
required
number decimal places <= 2 >= 0

The total USD amount being claimed

description
required
string

Valid values: a-Z, 0-9, spaces and ,.#$&()?=+-!

object
pecAcknowledgment
boolean

True if the claim is NOT related to any pre-existing condition that was present during any waiting period or prior to purchasing the policy.

certifiedInfoAck
string <date-time>

Date user certifies following statement: I certify the information provided is accurate to the best of my knowledge. I authorize any veterinary hospital or veterinarian to provide additional information about my pet to Odie or its third-party administrators. I understand that missing information or delays in delivering my pet’s medical records may delay the processing of my claim.

crimeAck
string <date-time>

Date user certifies following statement: I understand it is a crime to knowingly provide false, incomplete or misleading information to an insurance company for the purpose of defrauding the company.

Responses

Callbacks

Request samples

Content type
application/json
{
  • "webhook": "https://myserver.com/send/callback/here",
  • "dateOfService": "2019-08-24",
  • "category": "CLAIMTYPEACCIDENT",
  • "amountClaimed": 0,
  • "description": "string",
  • "veterinaryPractice": {
    },
  • "pecAcknowledgment": true,
  • "certifiedInfoAck": "2019-08-24T14:15:22Z",
  • "crimeAck": "2019-08-24T14:15:22Z"
}

Callback payload samples

Callback
POST: We callback on this webhook whenever the status of
Content type
application/json
{
  • "changeId": "XGHYCJSU",
  • "changeType": "Claim_Updated",
  • "entity": "CLAIM",
  • "webhook": "https://myserver.com/send/callback/here",
  • "changeTimestamp": "2019-08-24T14:15:22Z",
  • "claim": {
    }
}

Add a new document to a claim

Document upload is only available when claim status is "CLAIMNEEDSUSERACTION".

Use form-data to set Key values "documentType" and "document". The document must be provided as a binary file object and not a URL, only one document at a time is supported.

Document upload only supports .jpg, .jpeg, png, and .pdf filetypes. File requirements are case sensitive.

Webhook Payload: /need-user-action-callback

Endpoint Guide:

  1. A claims callback is sent to your endpoint that was given when submitting a claim with the status "CLAIMNEEDSUSERACTION"
  2. Submit document(s) using this endpoint.
  3. When all files are submitted, notify Odie claims department that all documents are submitted and ready for review by calling the "review-documents" endpoint.
Authorizations:
X-API-KEY
path Parameters
claimNumber
required
string

The claim to which you want to add a document

Request Body schema: multipart/form-data
document
required
object <binary>

The file to upload. The file to upload. Document upload only supports .jpg, .jpeg, .png, and .pdf filetypes. File requirements are case sensitive.

documentType
required
string
Enum: "Medical_Report" "Veterinary_Invoice" "Other_Document"

The Document type of the uploaded file

Responses

Send claim documents to review

Notify our Claims Department that all documents have been uploaded for a specific claim. This will change the claim status from "Needs User Action" to "Awaiting Review".

Authorizations:
X-API-KEY
path Parameters
claimNumber
required
string

The claim to which you want to send to review

Responses

Get last payment info

Returns payment info

Authorizations:
X-API-KEY
path Parameters
claimNumber
required
string

The claim to which you want to send to review

Responses

Submit payment method

You can submit payment method when claim status is CLAIMCLOSEDPAYMENTPENDING. Returns payment info

Authorizations:
X-API-KEY
path Parameters
claimNumber
required
string

The claim to which you want to send to review

Request Body schema: application/json
One of
type
required
string
Value: "bank"

Payment method

accountType
required
string
Enum: "checking" "savings"
accountNumber
required
string
routingNumber
required
string

Responses

Request samples

Content type
application/json
{
  • "type": "address",
  • "addressLine1": "string",
  • "addressLine2": "string",
  • "country": "US",
  • "postalCode": "string",
  • "state": "string",
  • "printBusinessName": "string",
  • "printName": "string"
}

Set Claim Webhook Url

Update claim webhook url

Authorizations:
X-API-KEY
path Parameters
claimNumber
required
string

The claim for which to update the webhook url

Request Body schema: application/json
webhook
string <uri>

URL of a webhook to call back whenever the claim status changes. Use this to notify your users of changes to their claim as it goes through the approval process.

Responses

Request samples

Content type
application/json
{}

Breed

Get breed list

Returns a list of all breeds. Record_ID = breedPK

Responses

Get a breed details by breedId

Get a single breed details by breed id. Record_ID and breedPK = "breed id"

path Parameters
breedId
required
string

The unique identifier of this breed in the Odie system.

Responses

Pet

Get a pet

Retrieve a single pet by petId

Authorizations:
X-API-KEY
path Parameters
petId
required
string

The unique identifier of this pet in the Odie system.

Responses

Update a pet

Update the details of a pet. Updates to the following fields will require review and approval from the Odie team if the user has any active policies:

  • breed
  • age
  • name
  • gender

If the request requires approval you will receive a statusCode of "PENDING, however fields not requiring approval will be updated immediately. Use the policy webhook to receive a callback once the change is approved. Updates which only contain fields not requiring approval, or for users with no active policies, will be made immediately (statusCode "UPDATED").

Authorizations:
X-API-KEY
path Parameters
petId
required
string

The unique identifier of this pet in the Odie system.

Request Body schema: application/json
breed
string

Breed primary key. Required for INJURY_AND_ILLNESS quotes. Must always be filled before checking out. Breed keys can be found using the Breed endpoint "/api-docs#tag/Breed"

age
string

Age keyword list is located here. Required for INJURY_AND_ILLNESS quotes. Must always be filled before checking out.

name
string

The pet's name.

gender
string
Enum: "MALE" "FEMALE"
changeReason
string

Description of a reason why user decided to make changes

Responses

Request samples

Content type
application/json
{
  • "breed": "string",
  • "age": "string",
  • "name": "string",
  • "gender": "MALE",
  • "changeReason": "string"
}

Add a new document to a pet

Upload a file to the pet

Authorizations:
X-API-KEY
path Parameters
petId
required
string

The pet to which you want to add a document

Request Body schema: multipart/form-data
document
required
string <binary>

The file to upload. The file to upload. Document upload only supports .jpg, .jpeg, .png, and .pdf filetypes. File requirements are case sensitive.

documentType
required
string
Value: "Medical_History"

The Document type of the uploaded file

Responses

User

Get a user

Retrieve a single pet by userId

Authorizations:
X-API-KEY
path Parameters
userId
required
string

The unique identifier of this user in the Odie system.

Responses

Update a user

Update the details of a user. A user is defined as anyone in the system, eg anyone who has requested a quote or has an active policy. Updates to the following fields will require review and approval from the Odie team if the user has any active policies:

  • firstName
  • lastName
  • contact:
    • line1
    • line2
    • city
    • state
    • zipCode
    • shippingLine1
    • shippingLine2
    • shippingCity
    • shippingState
    • shippingZipCode

If the request requires approval you will receive a statusCode of "PENDING, however fields not requiring approval (eg contact.email and contact.phone) will be updated immediately. Use the policy webhook to receive a callback once the change is approved. Updates which only contain fields not requiring approval, or for users with no active policies, will be made immediately (statusCode "UPDATED").

Authorizations:
X-API-KEY
path Parameters
userId
required
string

The unique identifier of this user in the Odie system.

Request Body schema: application/json
required

Any omitted fields will be left as they were. At least one field must be included.

firstName
string

Valid values: a-Z, 0-9, spaces and ,.#$&()?=+-!

lastName
string

Valid values: a-Z, 0-9, spaces and ,.#$&()?=+-!

stripeToken
string

Use this to update or add a credit card. If the user has any policies in a payment method transition of "PAYROLL to CREDITCARD" then we will generate subscriptions for these policies too. Use the following Stripe documentation to set up the payment form and capture the token. Ask your Odie contact for the publishable keys, note that if you are using a sandbox X-API-KEY then Stripe tokens must be generated with the test publishable key for Stripe and vice-versa for live X-API-KEYs. https://stripe.com/docs/payments/accept-a-payment-charges

object

Details of the user's linked bank account, which is used to pay out claims. Omitted if they do not have an account linked.

object (Contact)

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "stripeToken": "tok_1InQlDDhWLhOvPtT3xRb9U2y",
  • "bankAccount": {
    },
  • "contact": {
    }
}

Get a list of policies by user id

Get the full list of policies associated to a specific user id

Authorizations:
X-API-KEY
path Parameters
userId
required
string

The unique identifier of this user in the Odie system.

Responses

Get a list of billing information items by user id

Get a list of billing information items retrieved from Stripe associated to a specific user id

Authorizations:
X-API-KEY
path Parameters
userId
required
string

The unique identifier of this user in the Odie system.

Responses

Update a user payment method

Currently only PAYROLL to CREDITCARD is supported. The flow is as a follows:

  1. [Partner] Use this endpoint to tell Odie of the intent to change paymentMethod
  2. [Partner] On cancellationPeriodStart: Notify the customer via email that their 30-day cancellation period has started
  3. [Partner] Continued responsibility of Payroll as payment method through 30-day cancellation period.
  4. [Odie] On deadline: Policy is automatically cancelled if a credit card has not been added. You will receive a callback via the normal policy callback mechanism.

If the user does enter their credit card, you should use the PATCH /user/:userId endpoint to set the stripeToken. Once this is done the above steps are stopped and their policies become regular CREDITCARD payment policies. *This method works only for policies with monthly payment period

Authorizations:
X-API-KEY
path Parameters
userId
required
string

The unique identifier of this user in the Odie system.

Request Body schema: application/json
required
paymentMethod
required
string
Value: "CREDITCARD"

The new payment method. CREDITCARD is the only supported value.

policyPaidThroughDate
required
string <date>

The date on which the payment method change is effective. Must the the last day of a billing period.

Responses

Request samples

Content type
application/json
{
  • "paymentMethod": "CREDITCARD",
  • "policyPaidThroughDate": "2019-08-24"
}

Document

Gets a presigned url for uploading a document to S3

Use this top upload documents which can be linked to other entities

Authorizations:
X-API-KEY
query Parameters
fileName
required
string

The name of the file that will be uploaded. Filetypes are case-sensitive and must be a .plain, .pdf, .png, .jpg, .jpeg or .heic
Use the following request to upload the file once you have the presigned url:

  method: "PUT"

  uri: presignedUrl

  body: [file binary]

Responses

Renewals

Get monthly renewal payload

Use this to get a monthly renewal payload

Authorizations:
X-API-KEY
query Parameters
policyNumber
required
string

The number of the policy

Responses

Get daily renewal payload

Use this to get a daily renewal payload

Authorizations:
X-API-KEY
query Parameters
policyNumber
required
string

The number of the policy

Responses

Get Renewal_Created payloads

Use this to get a Renewal_Created payloads

Authorizations:
X-API-KEY
query Parameters
policyNumber
string

The number of the policy

startDate
string <date>

The start date, format

endDate
string <date>

The end date

Responses

Get Renewal_Renewed payloads

Use this to get a Renewal_Renewed payloads

Authorizations:
X-API-KEY
query Parameters
policyNumber
string

The number of the policy

startDate
string <date>

The start date, format

endDate
string <date>

The end date

Responses

Send Renewal_Created webhooks

Use this to send a Renewal_Created payloads

Authorizations:
X-API-KEY
query Parameters
policyNumber
string

The number of the policy

startDate
string <date>

The start date, format

endDate
string <date>

The end date

Responses

Send Renewal_Renewed webhooks

Use this to send a Renewal_Renewed payloads

Authorizations:
X-API-KEY
query Parameters
policyNumber
string

The number of the policy

startDate
string <date>

The start date, format

endDate
string <date>

The end date

Responses

Webhook Events

Resend latest webhook events

Resend latest webhook events for entities

Authorizations:
X-API-KEY
Request Body schema: application/json
One of
policyNumber
required
string

The number of the policy

Responses

Request samples

Content type
application/json
{
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24"
}