Added

New integration secret key for generating agency access tokens

We have added support for generating a temporary access token for a particular agency: The "Create token" endpoint.

To use this endpoint, you will need to be issued a new integration secret key by your Root representative. Your integration secret key will be used as the bearer token for this new endpoint, which will generate an agency access token when provided a valid value for one or more of the following body parameters:

FieldDescription
agentEmailThe email of the agent you would like to attribute to quotes made with this token
agentIdThe ID of the agent you would like to attribute to quotes made with this token
partnerAgencyIdThe partner agency ID you want to authorize with this token
tokenReferenceThe specific reference to a credential associated with a partner agency

Once generated, the agency access token may be used as the bearer token for any of the other API endpoints. See the list at the bottom of this page for all endpoints which are affected by this change.

More details can be found in our authentication guide.

Example

Request

{  
  "agentEmail": "[email protected]"  
}  

Response

{  
  "bearerToken": "fzJ0hXBiOiJKV2QiLCJhbGciOiJFUzI1NiJ9.eyJyZWZi1iI2KEtjZWdkWTVHYDtKMVVISjlTV3BGcFkiLCJqYXQiOjE3NDc0MjA4MzgsImV4cCI6NTc0NzUxMDczOCwiYWdlbnRJZCI6IjJlZDQ3OTQ1LWQxYjMtNDIxNS04ZmNlLWYzNjExMTFhYTJlYyK8.CVjlNNHrTGH1t_4b-lGxfSBbTqgk7tv-HvAnBZsCdC8rlk0BwnqT-puTBNGFPdJ2vx9I7SElqpWgTmjDJrNxfh",  
  "tokenPayload": {  
    "ref": "7XKcegdY6GakJ1UHJ9SWpFkC",  
    "iat": 1711234567,   
    "exp": 1711839367,    
    "agentId": "677c6943-52d8-4fdb-a4b0-1ea4e16d96f9"
  }  
}

Affected Endpoints