API Documentation

Our API is used for partners in our affiliate program to help submit referrals to us, or manage advisor portfolios. If you are interested in joining our partner program, please email team@nomadinsurance.com.

contract Requests

POST /create

Create a new user and contract with our agency without any parent entity relationships.

Parameters:

displayName (string) : Display name on your affiliate page, will default to your first and last name if not provided.
firstName (string) *: First name of the user.
lastName (string) *: Last name of the user.
email (string) *: Email address of the client.

Sample Response:

{
  "status": "success",
  "data": {
    "userId": 789,
    "message": "Contract created successfully."
  }
}

POST /create_referral

Create a new referral to be added underneath a partner, advisor, or org user account.

Parameters:

displayName (string) : Display name on your affiliate page, will default to your first and last name if not provided.
firstName (string) *: First name.
lastName (string) *: Last name.
email (string) *: Email address.

Sample Response:

{
  "status": "success",
  "data": {
    "userId": 789,
    "message": "Referral created successfully."
  }
}

POST /create_partner

Create a new partner to be added underneath an advisor or org user account.

Parameters:

displayName (string) : Display name on your affiliate page, will default to your first and last name if not provided.
firstName (string) *: First name.
lastName (string) *: Last name.
email (string) *: Email address.

Sample Response:

{
  "status": "success",
  "data": {
    "userId": 789,
    "message": "Partner created successfully."
  }
}

POST /create_advisor

Add a new advisor to be added underneath an organization user account.

Parameters:

displayName (string) : Display name on your affiliate page, will default to your first and last name if not provided.
firstName (string) *: First name.
lastName (string) *: Last name.
email (string) *: Email address.

Sample Response:

{
  "status": "success",
  "data": {
    "userId": 789,
    "message": "Advisor created successfully."
  }
}

POST /create_org

Create a new organization to be added underneath your user account.

Parameters:

displayName (string) : Display name on your affiliate page, will default to your first and last name if not provided.
firstName (string) *: First name.
lastName (string) *: Last name.
email (string) *: Email address.

Sample Response:

{
  "status": "success",
  "data": {
    "userId": 789,
    "message": "Organization created successfully."
  }
}

policy Requests

POST /get

Retrieve a policy.

Parameters:

policyId (number) *: ID of the policy to retrieve.

Sample Response:

{
  "status": "success",
  "data": {
    "id": 456,
    "policyName": "Sample Policy",
    "updated_at": "2023-10-19T14:30:00Z",
    "status": "Active",
    "modal_frequency": "Monthly",
    "effective_date": "2023-01-01",
    "end_date": "2023-12-31",
    "total_premium": 1200,
    "deductible": 250,
    "policy_number": "POL123456",
    "country_code": "US",
    "plan_id": 789,
    "referral_id": 1011,
    "partner_id": 1213,
    "org_id": 1415
  }
}

POST /update_address

Update policy address.

Parameters:

policy_id (number) *: ID of the policy for which the address is being updated.
country (string) *: Country of the address.
address_line_1 (string) *: First line of the address.
address_line_2 (string) : Second line of the address (optional).
city (string) *: City of the address.
zip (string) *: Zip or postal code.

Sample Response:

{
  "status": "success",
  "message": "Update policy address successfully."
}

POST /add_newborn

Add a newborn to the policy.

Parameters:

policy_id (number) *: ID of the policy to which the newborn is being added.
first_name (string) *: First name of the newborn.
last_name (string) *: Last name of the newborn.
dob (date) *: Date of birth of the newborn.
birthplace (string) *: Place of birth of the newborn.
gender (string) *: Gender of the newborn.
nationality (string) *: Nationality of the newborn.

Sample Response:

{
  "status": "success",
  "message": "Newborn added to the policy successfully."
}

POST /add_dependent

Add a dependent to the policy.

Parameters:

policy_id (number) *: ID of the policy to which the dependent is being added.
first_name (string) *: First name of the dependent.
last_name (string) *: Last name of the dependent.
dob (date) *: Date of birth of the dependent.
birthplace (string) *: Place of birth of the dependent.
gender (string) *: Gender of the dependent.
nationality (string) *: Nationality of the dependent.
weight (number) *: Weight of the dependent (in appropriate unit, e.g., kilograms).
height (number) *: Height of the dependent (in appropriate unit, e.g., centimeters).
phone (string) *: Phone number of the dependent.
email (string) *: Email address of the dependent.
id_number (string) *: Identification number of the dependent (could be SSN, passport number, etc.).
relationship (string) *: Relationship of the dependent to the primary policyholder (e.g., spouse, child).

Sample Response:

{
  "status": "success",
  "message": "Dependent added to the policy successfully."
}

POST /update_coverage

Update policy coverage.

Parameters:

policy_id (number) *: ID of the policy for which the coverage is being updated.
plan_id (number) *: ID of the new plan being set for the policy.
deductible (number) *: The amount to be paid out of pocket before an insurer pays any expenses.
modal_frequency (string) *: Payment frequency for the policy premium (e.g., Monthly, Quarterly, Annually).
total_premium (number) *: Total premium amount for the policy.
country (string) *: Country for which the coverage is applicable.

Sample Response:

{
  "status": "success",
  "message": "Policy coverage updated successfully."
}

POST /send_receipt

Send policy receipt.

Parameters:

policy_id (number) *: ID of the policy for which the receipt is being sent.
email (string) *: Email address where the receipt should be sent.

Sample Response:

{
  "status": "success",
  "message": "Policy receipt sent successfully."
}

client Requests

POST /sign

Sign a document.

Parameters:

policy_id (number) *: ID of the policy associated with the document.
document_id (number) *: ID of the document to be signed.

Sample Response:

{
  "status": "success",
  "message": "Document signed successfully."
}

POST /application

Submit a client application.

Parameters:

plan_id (number) *: ID of the plan for the application.

Sample Response:

{
  "status": "success",
  "message": "Client application submitted successfully."
}

POST /quote

Get a client quote.

Parameters:

plan_id (number) *: ID of the plan for the quote.
dob (date) *: Date of birth of the client.
spouse_dob (date) : Date of birth of the client's spouse (if applicable).
country (string) *: Country of residence of the client.

Sample Response:

{
  "status": "success",
  "data": {
    "quote": "Estimated premium amount or details."
  }
}

POST /referral

Submit a client referral.

Parameters:

email (string) *: Email address of the referral.

Sample Response:

{
  "status": "success",
  "message": "Client referral submitted successfully."
}

POST /ticket

Submit a client ticket.

Parameters:

email (string) *: Email address of the client.
department (string) *: Department to which the ticket is being addressed.
subject (string) *: Subject of the ticket.
message (string) *: Detailed message or issue the client is facing.

Sample Response:

{
  "status": "success",
  "message": "Client ticket submitted successfully."
}

POST /ticket_status

Check client ticket status.

Parameters:

ticket_id (number) *: ID of the ticket whose status is being checked.

Sample Response:

{
  "status": "success",
  "data": {
    "ticket_status": "Open or Closed or In Progress, etc."
  }
}

portfolio Requests

POST /renewal

Submit a portfolio renewal.

Parameters:

policy_id (number) *: ID of the policy being renewed.

Sample Response:

{
  "status": "success",
  "message": "Portfolio renewal submitted successfully."
}

GET /renewals

Get all portfolio renewals.

Parameters:

Sample Response:

{
  "status": "success",
  "data": {
    "renewals": "List of all renewals."
  }
}

GET /overrides

Get all portfolio overrides.

Parameters:

Sample Response:

{
  "status": "success",
  "data": {
    "overrides": "List of all overrides."
  }
}

POST /dividend

Manually apply a dividend to one of your sub referrals. This can be used for custom incentives, etc.

Parameters:

user_id (number) *: ID of the user receiving the dividend.
amount (number) *: Amount of the dividend.
description (string) *: Description or reason for the dividend.

Sample Response:

{
  "status": "success",
  "message": "Dividend applied successfully."
}

GET /payments

Get all portfolio payments.

Parameters:

Sample Response:

{
  "status": "success",
  "data": {
    "payments": "List of all payments."
  }
}