Quickstart

Get up and running quickly

Make sure your DoTrust account is set up and you have retrieved your API key from https://console.dotrust.co.uk

PREPARE by configuring your risk management profiles in the DoTrust Console and creating your API key.

Each request to the API follows the same pattern with a single POST request with a Bearer token, a JSON body; and a JSON response. Check out the API tab for details.

Example request/response

POST: https://api.dotrust.co.uk/api/v2/lighttouchvulnerability
HEADER: Authorization Bearer <YOUR_SECRET_TOKEN>
BODY:
{ 
  customer_id: 'U1234578',
  given_name: 'Fred', 
  surname: 'Flintstone'
  dob: '10-12-1970',
  house_name_number: '32a',
  street: 'Breakrock Avenue',
  city_town: 'Rubbletown',
  postcode: 'BR1 2TU',
  mobile: '07311888721'
}

RESPONSE: 
{
    request_id: 1234-12341234-1234-ABCD,
    timestamp: '2024-08-17T15:00:00',
    customer_id: 'U1234578',
    inquiry: 'lighttouchvulnerability',
    data: { 
        rag: "A",
        flagged: ["Bankruptcy", "Debt Relief Order"],
        not_flagged: ['Individual Voluntary Arrangement"]
    }
}

Most assessments and scans have additional information which is available to you for further investigation in the DoTrust Complete Console.