Migrating to the Vertical Insure API shim
This document describes the steps required to begin using the ‘API shim’ which Vertical Insure has produced to make the transition away from USSCI’s ‘raterspot’ API as smooth as possible.
Get access to Vertical Insure Partner Portal
The Vertical Insure Partner Portal is used by partners to view trends in issued premium, view request logs and bound policies, see request logs, and more. Having access will be useful because it will allow you to see if policies are being bound successfully when testing or once your migration is completed. To onboard you onto the Vertical Insure Partner Portal, we need the following information from you regarding your company:
- Legal business name
- Friendly business name
- Email address (This email address will be the first person to receive a login invite link via email, this user can then change partner information in the portal and invite other users)
- Website URL
Once we have this information from you, we can send an invite to the partner portal via email which will allow you to log in.
Provide credentials to Vertical Insure, or accept new ones
Vertical Insure did not get an exhaustive list of credentials in the transition, so to ensure that this migration goes smoothly, we need to know which credentials you plan to call the API with. There are two options: either you can privately send us all of the access tokens that you currently use to call the raterspot USSCI API, or we can generate new ones for you and provide them to you.
To call the old API, or our new shim, two tokens must be provided:
- The access token provided via the 'x-access-token', which never changes
- The URL token which is at the end of the URL, which decides which environment and which product is being targeted
For example, if your integration requires you to call the 'bill and bind' API for both SportsFee and CEC (Event Cancellation), you should provide us:
- Access token
- Development SportsFee URL token
- Production SportsFee URL token
- Development CEC URL Token
- Production CEC URL Token
If you cannot provide these, we can generate new ones for you and send them to you instead.
Update the URL, and potentially the tokens, that you are using
You should identify where, in your codebase or configuration, the USSCI raterspot API URL appears:
https://rest.raterspot.com/ussci
These references should be replaced with the new Vertical Insure API shim URL:
https://regsaver.legacy.api.verticalinsure.com/ussci
Additionally, if you opted to receive new credentials, you should locate wherever these are stored, and update them with the new values. It is important that these changes go out at the same time (the old API URL will not accept the new credentials). Note that the API URL is the same for development and production–whether or not a test policy or a real policy is bound is decided only by the URL token that is used. How you perform the migration is up to you, but if you have a development or test environment, it’s a good idea to try testing there first with the developer access token to confirm if you can successfully bind test policies.
Confirm success
Finally, confirm that the integration is working by walking through the process for obtaining a policy, and confirming that a policy is bound. The policyholder will receive an email from Vertical Insure confirming the purchase and containing a link to view the policy document, and additionally the policy will show up in the partner portal (please be sure to hit the “LIVE/TEST” toggle in the corner if you are looking for a test policy!).
Additional Fields in SportsFee
We have added support for a handful of new optional fields in the SportsFee request body to enable partners to pass information required for better client support and to support coverage for registrations on payment plans. The following fields are now supported:
otherData.orgContactEmail:String. Optional. This should be the email address of the 'contact' for the Sports club or organization.otherData.paymentPlan:boolean. Optional. This should be a booleantrueorfalseindicating whether or not the registration is paid on a payment plan.
Here is an example of the new fields in use:
{
"insured": {
"zip": "12345",
"state": "CA",
"phone": "5555555555",
"name": "Test User",
"email": "testuser@example.com"
},
"otherData": {
"teamName": "Team B (26/27)",
"lastName": "User",
"parentLastName": "User",
"gender": "Male",
"clubName": "Test Soccer Club",
"endOfSeason": "2027-05-01",
"startOfSeason": "2026-05-01",
"firstName": "Test Jr",
"parentFirstName": "Test",
"dob": "2011-12-02",
"registrationDate": "2026-05-01",
"totalSportsFee": 3850,
"plan": "Elite Plan",
"sport": "Soccer",
"orgContactEmail": "my.club.administrator@example.com",
"paymentPlan": true
},
"pricing": [
{
"amount": 260.29,
"name": "Sport Premium",
"type": "Premium"
},
{
"amount": 9.11,
"name": "Surplus Lines Tax",
"type": "Taxes"
},
{
"amount": 0.1,
"name": "Stamping Fee",
"type": "Taxes"
}
]
}