Addresscloud is a UK-based geospatial intelligence platform that provides  property-level risk and address data through APIs.

Addresscloud Integration: Using API Response Data in SchemeServe

Addresscloud can be integrated into SchemeServe to retrieve address intelligence data, such as burglary scores, flood scores, or other risk-related values.

How it works

An API request is created using the API Builder (found within a policy in the bottom right). The response from Addresscloud is then stored against a  question, usually a hidden question, so the returned value can be used elsewhere in the scheme.

For example:

Addresscloud returns a burglary score.

The score is stored in a hidden question, such as BurglaryScore.

SchemeServe can then use that value in rules, referrals, endorsements, or rating logic.

Example:

Question setup

• Create a question in the question set to store the API result.
• Set the answer type to:

This question can be hidden from users if it is only required for rating, referrals, or internal processing.

Here is an example of what may be populated within the question once the API
request has been run:

You can then populate a hidden question using the response by copying a specific line of data from the reponse:
SetCover:FloodScore
[AddressCloudAPIrequest_view_summary_coastal_floodscore_def_class]

Adding the API call

The API call is built in the API Builder.

Once configured, copy the request from the Rating Format tab and add it near the top of the rating file or in your rules.

Adding the API request near the top of the rating file ensures the Addresscloud data is returned before any formulas, rules, referrals, or other actions rely on the response.

This is especially important where referrals are based on returned API values.

Example use case

• User enters an address.
• SchemeServe sends the address to Addresscloud.
• Addresscloud returns risk data.
• The burglary score is stored in a hidden API response question.
• A referral rule checks the stored score.
• If the score is above the agreed threshold, a referral is created.
  
  Rating file example:
  ApiRequest:MP_AddressCloudData
[ [GroupBy Field="MP"]  { "request": { "method": "GET", "headers": [{ "Key": "x-api-key", "Value": "xxQqgCxxV660ESGrCxx1089Cg6xAxA6sY1gNxT80" }, { "Key": "x-client-id", "Value": "schems" }], "url": "https://api.addresscloud.com/intel/v1/address/intel/byAddress?query=##UrlEncode([MP_PremisesAddress])##&view=summary", "body": "" }, "responseDataLocations":  [   ] }, [/GroupBy]]
   
• You can then populate a hidden question using the response:
  SetCover:FloodScore
  [AddressCloudAPIrequest_view_summary_coastal_floodscore_def_class]
   

Example rule logic:

Important notes

• Special characters in address fields can cause API errors, so address values should be URL encoded.
• For multi-property or multi-page schemes, the API request may need to be included in the rating file so it runs for each relevant property.