ValidateIQ is Pickr's intelligent machine learning powered tool for assessing evidence submitted for infrastructure projects. ValidateIQ will provide a score on how likely the submitted evidence is likely to be approved/signed off.

You must contact Pickr to get access to this API. Email us at hello[at]pickr[dot]works

ValidateIQ's authentication is provided by Pickr's Identity service. You will need to contact this service to get an access token before you call call ValidateIQ API endpoints.

Access tokens will expire one hour after issuing. They are in JWT format. The endpoint to retrieve a token is https://id.pickr.works/connect/token

A cURL example:

curl -d "grant_type=client_credentials&client_id=My_Client_Id&client_secret=My_Client_Secret" -X POST https://id.pickr.works/connect/token

This will return the following JSON response:

{
    "access_token": "eyJhb...mJnd47jM",
    "expires_in": 3600,
    "token_type": "Bearer"
}

You will need to use the access_token for all API calls, and you will need to request a new token every hour.

Add a Authorization header to all API requests with your access token prefixed with Bearer, for example:

Authorization: Bearer eyJhb...mJnd47jM

ValidateIQ is an asynchronous API. When we receive your request it is queued and processed as quickly as possible. You have multiple options of how to be notified of the responses once your request has been processed. We will talk about those later.

To submit a new analysis request you need to provide the following properties in JSON format:

An example JSON payload would be:

{
    "AnalysisId": "6f056479-187a-4f71-a87d-dff53a07cd68",
    "Code": 1,
    "WebhookUrl": "https://my-webhook.url/",
    "WebhookSecret": "my-super-secret-code",
    "ImageUrls": ["... image url ..."],
    "Quantity": 5
}

An example cURL request would be:

curl -d "{ \"AnalysisId\": \"6f056479-187a-4f71-a87d-dff53a07cd68\", \"Code\": 1, \"WebhookUrl\": \"https:\/\/my-webhook.url\/\", \"WebhookSecret\": \"my-super-secret-code\", \"ImageUrls\": [\"... image url ...\"], \"Quantity\": 5 }" -H "Authorization: Bearer <token here>" -X POST https://api.validateiq.com/iq/analysis

A example successful response is (HTTP code 200):

{
    "id": "6f056479-187a-4f71-a87d-dff53a07cd68",
    "version": "v1",
    "code": 1
}

You can submit multiple requests with the same analysis ID and code, and we will create incrementing versions. Images from previous versions are copied across. This is useful for adding new images to an analysis. Each version will produce a response and webhook call/email.

For each subsequent request that you send, the new quantity value will override the existing one. If you do not specify a quantity, the quantity value from the previous analysis version will be used.

We recommend using webhooks as the best way to receive a response to your analysis requests.

Once we have processed your request we will immediate trigger a webhook response if you provided a url to us when making the request. If you do not provide a webhook secret we will default to an empty string.

Webhooks are sent to you as POST HTTP method, with the following payload:

{
   "Secret":"my-super-secret-code",
   "AnalysisId":"6f056479-187a-4f71-a87d-dff53a07cd68",
   "Code":1,
   "Version": "v1",
   "Quantity: 5
   "Result":{
      "CheckResponses":[
         {
            "Name":"Dummy Check",
            "Weight":1,
            "Score":86.41125
         }
      ],
      "OverallScore":86.41125,
      "ManualCheckRequired":true,
      "ManualCheckReason":"Minimum threshold not reached.",
      "QuantityResults":[
         {
            "Name": "Dummy Check",
            "Quantity: 1
         }
      ]
   }
}

CheckResponses may contain additional properties depending on the check type, but will always contain Name, Weight and Score.

You can poll an endpoint to check if an analysis has been processed yet. We do not recommend this, we would suggest using a webhook.

The endpoint is:

https://api.validateiq.com/iq/analysis/{id}-{code}/{version?}

The version parameter is option, if omitted it will return the latest version.

An example cURL request would be:

curl -H "Authorization: Bearer <token here>" -X POST https://api.validateiq.com/iq/analysis/6f056479-187a-4f71-a87d-dff53a07cd68-1

or, to get a specific version:

curl -H "Authorization: Bearer <token here>" -X POST https://api.validateiq.com/iq/analysis/6f056479-187a-4f71-a87d-dff53a07cd68-1/v1

The result will be the same as the webhook above, with the addition of a Secret key which is the same as the WebhookSecret property you passed to us when making your request.

For threshold analysis, you can provide an Email property when creating an analysis request. If the analysis result has an overall score of <90% then we will send you an email notification.

Covid 19 README