Onboard Agency
Register and onboard a new agency as a downline partner on White Swan.
This endpoint can be used to create an onboarding link for new agencies under your company account with White Swan. Any account created through this onboarding link will be in your downline, and data that you provide with this call will be used to pre-fill and streamline onboarding for the user.
Creating an agency onboard link is different from inviting a user to your account. When you invite a user to your account, they will join your company account, meanwhile when you create an agency onboarding link, they will create their own company account, which will be a downline to your company account.
API Method:
POST https://app.whiteswan.io/api/1.1/wf/agency_onboard
Creates an agency onboarding link.
Headers
Authorization*
String
Bearer <YOUR API KEY>
Content-Type*
String
application/json
Accept*
String
application/json
user-agent*
String
<YOUR APP>
Request Body
JSON Body*
Object
See specification below
Sample Body Payload
{
"company_id": "1776772304993x692932671527100400",
"company_logo": "https://assets.whiteswan.io/logos/acme-logo-light.png",
"company_darkmode_logo": "https://assets.whiteswan.io/logos/acme-logo-dark.png",
"company_name": "Acme Insurance Group",
"company_type": "Agency",
"company_legal_name": "Acme Insurance Group LLC",
"company_address": "123 Main St, Austin, TX 78701, USA",
"company_account_plan": "Digital Agent Plan",
"company_npn":"123456789",
"company_scheduling_link": "https://calendly.com/acme-insurance",
"company_enabled_product_types": [
"Term Life",
"Whole Life",
"Indexed Universal Life"
],
"company_enabled_carriers": [
"John Hancock",
"Nationwide",
"Mutual of Omaha"
],
"company_broker_dealer_legal_name": "Acme Financial Services LLC",
"company_broker_dealer_address": "500 Market St, San Francisco, CA 94105, USA",
"company_broker_dealer_website": "https://www.acmefinancial.com",
"company_broker_dealer_phone_number": "+1-800-555-1122",
"company_invited_users": [
{
"user_email": "[email protected]",
"user_id": "1776772304993x812345678901234567",
"user_npn": "12345678",
"user_first_name": "Jane",
"user_last_name": "Doe",
"user_title": "Senior Insurance Advisor",
"user_scheduling_link": "https://calendly.com/jane-doe",
"user_phone_number": "+1-512-555-0101",
"user_profile_picture": "https://assets.whiteswan.io/profiles/jane-doe.jpg",
"user_licenses": [
{
"type": "Life",
"state": "TX",
"active": true
},
{
"type": "Health",
"state": "CA",
"active": true
}
],
"user_permission": "Admin"
},
{
"user_email": "[email protected]",
"user_id": "1776772304993x823456789012345678",
"user_npn": "87654321",
"user_first_name": "John",
"user_last_name": "Smith",
"user_title": "Insurance Agent",
"user_scheduling_link": "https://calendly.com/john-smith",
"user_phone_number": "+1-512-555-0202",
"user_profile_picture": "https://assets.whiteswan.io/profiles/john-smith.jpg",
"user_licenses": [
{
"type": "Life",
"state": "FL",
"active": true
},
{
"type": "Securities",
"state": "NY",
"active": false
}
],
"user_permission": "Agent"
}
]
}Please note that the sample body payload above contains all possible parameters for your reference. In an actual call, you don't need to use all parameters.
Code Examples - Making the API Call:
Code examples are available in cURL, Python, Javascript, Java, PHP, Ruby, and Go, but can be constructed for other languages and tools. Some code examples include dependencies that may need to be installed in your codebase to ensure functionality. Please note that the code examples above does not contain all available input fields. Feel free to edit using the specification below. Also remember to replace any values in the code that looks like <VALUE> and to adapt the parameter values passed.
Body Parameters Specification:
Company External ID
company_id
Text
No
1813426016
Any ID you may have in your own systems to identify a certain company. This ID can later be queried in the API.
-
Company Logo
company_logo
File URL
No
A publicly accessible URL (eg. S3) containing the logo image of the company.
-
Company Darkmode Logo
company_darkmode_logo
File URL
No
A publicly accessible URL (eg. S3) containing the darkmode logo image of the company.
-
Company Name
company_name
Text
No
Acme
The name of the company.
-
Company Type
company_type
Multiple-Choice
No
Independent Life Insurance Agency/Brokerage
What type of company this is.
Independent Life Insurance Agency/Brokerage, Captive Life Insurance Agency/Brokerage, Broker-General-Agent (BGA), Independent Marketing Organization (IMO), Field Marketing Organization (FMO), Life Insurance Carrier, Registered Investment Advisor (RIA), Broker-Dealer (BD), Fintech Company, Mortgage Provider, Property & Casualty Insurance Provider, Legal Services Provider, Other
Company National Producer Number (NPN)
company_npn
Text
No
123456789
The national producer number (NPN) of the entity.
-
Company Legal Name
company_legal_name
Text
No
Acme Inc LLC
The legal name of the company.
-
Company Address
company_address
Text
No
123 Main St, City, State, Zip, Country
The address of the company.
-
Company Account Plan
company_account_plan
Multiple-Choice
No
Digital Agent Plan
The subscription type this company should have. The invited user will have to confirm this plan selection.
Digital Agent Plan, Concierge Plan, Innovator Plan
Company Scheduling Link
company_scheduling_link
Text
No
The general scheduling link for the company.
-
Company Enabled Product Types
company_enabled_product_types
Text Array
No
["Term Life","Whole Life"]
The policy types that should be allowed for this company. If left empty the company will have the same allowed policy types as your company.
Term Life, Guaranteed Universal Life, Whole Life, Indexed Universal Life, Variable Universal Life, Private Placement Life, Final Expense, Linked Benefit, Long Term Care, Accidental Death
Company Enabled Carriers
company_enabled_carriers
Text Array
No
["John Hancock","Nationwide"]
The carriers that should be allowed for this company. If left empty the company will have the same allowed carriers as your company.
John Hancock, Nationwide, Life Insurance Company of the Southwest, Principal National Life Insurance, Transamerica, Corebridge Financial, Protective, Pacific Life - Lynchburg, Banner, Savings Bank Life Insurance, Lincoln National Life, Prudential Financial, North American, Assurity, American National, Principal Life Insurance Company, Allianz, National Western, John Hancock New York, William Penn, United of Omaha, Mutual of Omaha, U.S. Life, Nationwide New York, Prudential Life Insurance Company Of New Jersey (NY Only), Fidelity and Guaranty, Athene Annuity, Gerber, National Guardian Life, MassMutual Ascend, Protective New York, National Life Group, Thrivent, Global Atlantic, Guaranty Income life Insurance Company, American Equity, Equitrust, Revol One Insurance Company, Axonic, Symetra
Company Broker Dealer Legal Name
company_broker_dealer_legal_name
Text
No
Broker Dealer Inc
The legal name of the broker-dealer used by the company.
-
Company Broker Dealer Address
company_broker_dealer_address
Text
No
123 Main St, City, State, Zip, Country
The address of the broker-dealer used by the company.
-
Company Broker Dealer Website
company_broker_dealer_website
Text
No
https://brokerdealer.com
The website of the broker-dealer used by the company.
-
Company Broker Dealer Phone Number
company_broker_dealer_phone_number
Text
No
123-454-6789
The US phone number excluding country code of the broker-dealer used by the company
-
Company Invited User(s)
company_invited_users
Object Array
No
Each object defined below
An array of objects where each object represents an invited user to the new company account. At least one invitee has to be specified.
-
-External ID
user_id
DateTime
No
3683206808
An ID that you use to identify the invited person in your own system. This ID can later be used in API calls.
-
-National Producer Number (NPN)
user_npn
Text
No
12345678
The national producer number of an invited person.
-
-First Name
user_first_name
Text
No
John
The first name of an invited person.
-
-Last Name
user_last_name
Text
No
Doe
The last name of an invited person.
-
-Title
user_title
Text
No
CEO
The title of an invited person.
-
-Scheduling Link
user_scheduling_link
Text
No
https://calendly.com/john-doe
The scheduling link of an invited person.
-
-Phone number
user_phone_number
Text
No
123-455-6789
The US phone number excluding country code of an invited person.
-
-Profile Picture
user_profile_picture
Text
No
A publicly accessible URL pointing to a profile picture.
-
-User Permission
user_permission
Multiple-Choice
No
Admin
The permission level of the user - admin gives company wide access while agent limits access. If this user is the first user under this company, they will automatically be Admin, no matter what is specified here.
Admin, Agent
-User Licenses
user_licenses
Object List
No
-
An array of objects where each object represents one license. For each object, all parameters must be used.
-
--License Type
type
Multiple-Choice
No
Life
The type of license the invited person carries.
Life, Health, Securities, Property, Casualty
--License State
state
Multiple-Choice
No
CA
The state in which the invited person carrier a license, expressed in a 2 letter abbreviation format.
AL, AK, AZ, AR, CA, CO, CT, DE, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY
--License is Active
active
Boolean
No
true
Whether the license is active.
-
Returned Parameters Specification:
Onboarding Link
onboarding_link
Text
An onboarding link that can be used to onboard the new agency.
Last updated
Was this helpful?