HealthPilot - API Library (v1)

Download OpenAPI specification:Download

Support: apisupport@healthpilot.com URL: https://www.healthpilot.com/ License: HealthPilot External API License Terms of Service


The Healthpilot API Library provides our partners access to Healthpilot’s platform, features, and data. Integrating these APIs and services into an workflow can bring awareness to a much-needed Medicare resource and provide partners with an effortless, straightforward way to refer their clients to Healthpilot’s Medicare recommendation and enrollment experience.


Authentication

Our APIs uses JWT tokens to authenticate requests on each call. In order to receive a token, make a POST request to https://healthpilotadvisor.us.auth0.com/oauth/token.
The body of the request should be:

{
'client_id': '{{client_id_provided_by_Healthpilot}}'
'client_secret':'{{ client_secret_provided_by_Healthpilot }}'
'grant_type':'client_credentials'
}

Tokens are valid for 1 day.
When making calls to any of the endpoints below, this token must be passed in the header of the request as:

Authorization: Bearer {{access_token}}

AdvisorSetup

The Advisor Setup endpoint allows you to create an advisor record within the Healthpilot system. Creating an advisor is a prerequisite to importing clients and sending email referrals.

AdvisorSetup

Request
Request Body schema:
externalAdvisorId
required
string

The identifier given by the parent company to be used as a cross reference

advisorFirstName
required
string

First name of the advisor

advisorLastName
required
string

Last name of the advisor

advisorEmail
required
string

Email address of the advisor

firmName
required
string

The name of the advisor's firm

firmAddress
required
string

The firm's street address

firmAddress2
string or null

The firm's street address line 2

firmCity
required
string

The firm's city

firmState
required
string

The firm's state

firmZipCode
required
string

The firm's zip code

firmPhoneNumber
string or null

The phone number of the advisor or firm

firmBrokerRIA
string or null

The name of the Broker Dealer or RIA

Responses
200

The Advisor was added successfully

400

If any of the following are empty or not valid throw the corresponding error:

  • Please enter a valid advisor first name
  • Please enter a valid advisor last name
  • Please enter a valid advisor email
  • Please enter a valid firm name
  • Please enter a valid firm street address
  • Please enter a valid firm city
  • Please enter a valid firm state
  • Please enter a valid firm zip code

post/api/AdvisorSetup
Request samples
{
  • "externalAdvisorId": "4897755",
  • "advisorFirstName": "John",
  • "advisorLastName": "Smith",
  • "advisorEmail": "john@yahoo.com",
  • "firmName": "Lighthouse Wealth Management",
  • "firmAddress": "120 Brown Street",
  • "firmAddress2": "Suite 120",
  • "firmCity": "Springfield",
  • "firmState": "IL",
  • "firmZipCode": "95622",
  • "firmPhoneNumber": "9164456688",
  • "firmBrokerRIA": "Fidelity"
}
Response samples
application/json
{
  • "advisorGuid": "string",
  • "messages": [
    ]
}

ClientReferral

The Send Client Referral Email endpoint allows you to send an advisor’s client a referral email to Healthpilot’s Medicare enrollment experience. The email will contain a customized link that will associates the client’s progress within the enrollment process to the specific advisor.

SendClientReferralEmail

Request
Request Body schema:
advisorGuid
string or null

The Healthpilot guid assigned to the advisor - Required if Advisor email or external Advisor ID isn't present

externalAdvisorID
required
string

The external ID associated with the Advisor That Healthpilot would recognize- Required if Advisor email or Advisor Guid isn't present

advisorEmail
required
string

The email address of the advisor - Required if External Advisor ID or the Advisor Guid isn't present

clientGuid
string or null

The Healthpilot client identifier returned in a previous API response

templateGuid
required
string

The identifier of the email template to be used in the referral email

clientFirstName
required
string

First name of the client

clientLastName
required
string

Last name of the client

clientZipcode
required
string

The home zip code of the client

clientPhoneNumberMobile
string or null

The mobile phone number of the client

clientDateOfBirth
required
string

The birthdate of the client

clientEmail
required
string

The email address of the client

sendViaHealthpilot
required
string

('true' or 'false') If true then Healthpilot will send the email. If false then the client referral email will be sent internally and will contain the URL link in the response.

Responses
200

Success

400

If any of the following are empty or not valid throw the corresponding error:

  • Please enter a valid client first name
  • Please enter a valid client last name
  • Please enter a valid client zip code
  • Please enter a valid client birth date
  • Please enter a valid client email
  • Please enter 'true' or 'false' in the SendViaHealthpilot field. If 'true' then Healthpilot will send the email. If 'false' we will return a link for you to insert in an email referral.

404

If any of the following are empty or not valid throw the corresponding error:

  • Missing both a valid ExternalAdvisorID and an AdvisorEmail :
    • Please provide either a recognized id in the ExternalAdvisorID field or a recognized advisor email.
  • If no client can be found by email address search:
    • We couldn't find an advisor with that email address. Please use the Advisor Setup API to create this advisor first.
  • If no client can be found by ExternalAdvisorID search:
    • We couldn't find an advisor with that id. Please use the Advisor Setup API to create this advisor first.
  • If email can't be sent because of some backend issue:
    • We are unable to send the email at this time. Please try again later.
post/api/ClientReferral
Request samples
{
  • "advisorGuid": "D10D5347-0FBA-4063-A1F0-ED990251AE52",
  • "externalAdvisorID": "D10D5347-0FBA-4063-A1F0-ED990251AE52",
  • "advisorEmail": "john@yahoo.com",
  • "clientGuid": "3C6CA60A-AC75-419B-8926-AE2F96BA1BC3",
  • "templateGuid": "4PYCA60A-BC75-559B-8926-RT9F96BA1BC3",
  • "clientFirstName": "John",
  • "clientLastName": "Smith",
  • "clientZipcode": "95630",
  • "clientPhoneNumberMobile": "9165406588",
  • "clientDateOfBirth": "10/20/1950",
  • "clientEmail": "joe@gmail.com",
  • "sendViaHealthpilot": "true"
}
Response samples
application/json
{ }

ClientUpload

The Client Import endpoint allows you to bulk upload a list of up to X clients to be tied to a specific advisor record.

UploadClients

Request
Request Body schema:
Array
externalClientId
string or null

The identifier used by the parent company importing the data for the client

source
required
string

The source of the API request

dateOfBirth
required
string

The birthdate of the client

zipCode
required
string

The home zip code of the client

email
required
string

The email address of the client - Either PhoneNumber or Email is required

advisorExternalId
required
string

The identifier used by the parent company importing the data for the advisor

firstName
required
string

First name of the client

lastName
required
string

Last name of the client

phoneNumber
required
string

The mobile phone number of the client - Either PhoneNumber or Email is required

Responses
200

The call was completed successfully

post/api/ClientUpload
Request samples
[
  • {
    }
]
Response samples
application/json
{
  • "numberImported": 110,
  • "numberFailed": 10,
  • "numberAlreadyImported": 25
}