Authentication / Auth

The Main API uses a single static API key which can be generated by calling GetAPIKey endpoint with the broker’s username and password (Base64 encoded). This only needs to be performed once where you should then store the static key and pass it in the body (in some cases the header) of every subsequent call for that particular broker. The key will allow us to identify where the calls are coming from so that we can apply the user’s configuration and ascribe the quote/policy to their Uinsure account, should they want to access it using our web application.

Most integration partners include a section within their user account settings section. This does however run the risk of being hidden away from the user, thus it makes sense to include prompts upon login for example to drive the user to connect their accounts at launch.

Additionally, we have the ability to exchange a list of FCA numbers with our partners and generate/locate existing API keys to enable you to store these, in batch against each user from the outset. It is advised to do this once in the beginning and to then use the /auth endpoint for all new, subsequent users.

Request

POST /auth HTTP/1.1
Host: api.test.uinsure.co.uk
Accept: application/json
Content-Type: application/json
Content-Length: // length of request body as integer e.g. 77
{
  "EmailAddress": "user@uinsure.co.uk", 
  "Password": "password",
}