I/O Docs: API Documentation

OAuth 2.0 Flow: Select OAuth 2.0 Flow

Existing Client Credentials: Manual Input

API Key:

App/Key: Select Application Key Manually provide key information

Shared Secret:

Client ID:

Client Secret: Authorize

Client ID: Get Access Token

Client ID:

Client Secret:

---

Username:

Password: Get Access Token

Client ID:

Client Secret: Get Access Token

Authorization Code: Get Access Token

Access Token:

Username:

Password:

Username:

Binary Security Token:

Username:

Password:

• country

  • List Methods
  • Expand Methods

  • GET countries /countries

    returns a list of countries

  • GET country /countries/:country

    return information about the country

    Parameter	Value	Type	Description
    :country		string	the country you want information for

• OAuth Authentication

  • List Methods
  • Expand Methods

  • POST accessToken /accessToken

    The Access Token service provides authorization for users and client applications. Once authorized, an access token is granted for accessing resources and services via other API calls. Remember to pass in the API key you received using the HTTP header X-Auth-API-Key.

    Parameter	Value	Type	Description
    client_id		string	The identifier for the client application. This is the API key assigned to you when you applied to use this product. Even though this key is passed in all Travel Insurance API calls in the X-Auth-API-Key header, it is included here to stay consistent with OAuth 2 guidelines.
    client_secret		string	The secret 'password' provided to you along with your API key to access the Travel Insurance API. Note: Unlike the API key, this secret should be kept confidential and not shared with others.
    grant_type	password refresh_token	string	The OAuth 2 grant type. Must be one of the currently supported grant types, 'client_credentials', 'password', or 'refresh_token'
    user_name		string	Required if grant_type=password. If using the Resource Owner Password grant flow, this is the username of the user to be authenticated
    password		string	Required if grant_type=password. If using the Resource Owner Password grant flow, this is the password of the user to be authenticated
    refresh_token		string	Required if grant_type=refresh_token. The refresh token provided during the initial 'client_credentials' or 'password' flow

• Accounts

  • List Methods
  • Expand Methods

  • PUT changePassword /accounts/password

    Change Password

    Parameter	Value	Type	Description
    Authorization		string	The API key (generate above)
    Content-Type	application/x-www-form-urlencoded	string	Content Type
    oldPassword		string	Old password
    newPassword		string	New password

• Partners

  • List Methods
  • Expand Methods

  • GET partnerInformation /partners/:partnerCode

    Get Partner Information

    Parameter	Value	Type	Description
    Authorization		string	The API key (generate above)
    :partnerCode		string	Partner Code

  • GET productInformation /partners/:partnerCode/products

    Get Product Information

    Parameter	Value	Type	Description
    Authorization		string	The API key (generate above)
    :partnerCode		string	Partner Code

• Questionnaires

  • List Methods
  • Expand Methods

  • GET allQuestionnaires /questionnaires

    Get all Questionnaires

    Parameter	Value	Type	Description
    Authorization		string	The API key (generate above)
    lang	en fr	string	Questionnaire Language
    with_style	True False	boolean	Set to true to recieve html tags, classes etc.
    application_date		string	Questionnaire Application Date

  • GET getQuestionnaire /questionnaires/:id

    Get Questionnaire by ID

    Parameter	Value	Type	Description
    Authorization		string	The API key (generate above)
    :id		string	Questionnaire ID
    lang	en fr	string	Questionnaire Language
    with_style	True False	boolean	Set to true to recieve html tags, classes etc.
    application_date		string	Questionnaire Application Date

• Policies

  • List Methods
  • Expand Methods

  • GET policySearch /policies

    Search for Policies

    Parameter	Value	Type	Description
    Authorization		string	The API key (generate above)
    policyNumber		string	A policy Number
    applicationDateLower		string	After or equal to this Application Date
    applicationDateUpper		string	Before or equal to this Application Date
    effectiveDateLower		string	After or equal to this Effective Date
    effectiveDateUpper		string	Before or equal to this Effective Date
    expiryDateLower		string	After or equal to this Application Date
    expiryDateUpper		string	Before or equal to this Expiry Date
    partnerCode		string	Partner code to search, if user context is set set the users partner code as default
    travellerFirstName		string	The traveller's First Name
    travellerLastName		string	The traveller's Last Name
    travellerPhoneNumber		string	The traveller's Phone Number
    travellerEmailAddress		string	The traveller's Email Address
    travellerBirthDate		string	The traveller's birth date.
    offset		number	Search starting index
    limit		number	Max search results
    fullPolicyOption	True False	boolean	a flag to either return the full policy profile or a stripped down version for performance reasons

  • POST createPolicy /policies

    Create a policy

    Parameter	Value	Type	Description
    Authorization		string	The API key (generate above)
    Content-Type	application/json	string	Content Type
    actor		string	Partner / Agent Code

    Request Body
  • GET getPolicy /policies/:policyNumber

    Get a Policy

    Parameter	Value	Type	Description
    Authorization		string	The API key (generate above)
    :policyNumber		string	Policy Number

  • POST amend /policies/amend

    Amend a Policy

    Parameter	Value	Type	Description
    Authorization		string	The API key (generate above)
    Content-Type	application/json	string	Content Type
    policyNumber		string	A policy Number

    Request Body
  • POST renew /policies/renew

    Renew a Policy

    Parameter	Value	Type	Description
    Authorization		string	The API key (generate above)
    Content-Type	application/json	string	Content Type
    policyNumber		string	A policy Number

    Request Body
  • POST cancel /policies/cancel

    Cancel a Policy

    Parameter	Value	Type	Description
    Authorization		string	The API key (generate above)
    Content-Type	application/json	string	Content Type
    policyNumber		string	A policy Number

    Request Body
  • GET sendFulfillment /policies/:policyNumber/email

    Send a fulfillment

    Parameter	Value	Type	Description
    Authorization		string	The API key (generate above)
    :policyNumber		string	Policy Number
    lang	en fr	string
    email		string

• Quotes

  • List Methods
  • Expand Methods

  • POST price /quotes/price

    Get a Price

    Parameter	Value	Type	Description
    Authorization		string	The API key (generate above)
    Content-Type	application/json	string	Content Type
    actor		string	Partner / Agent Code

    Request Body

• Reporting

  • List Methods
  • Expand Methods

  • GET reports /reports

    Generate sales reports

    Parameter	Value	Type	Description
    Authorization		string	The API key (generate above)
    partnerCode		string	Partner code for reports
    reportType	sales sales_smi sales_smi_agent sales_smi_school sales_mga renewal comm comm_sched student	string	The type of report to be generated
    startDate		string	Start Date of report. Format: YYYY-MM-DD.
    reportFormat	pdf html	string	The format of the report to be generated
    lang		string	Language of report