PerformSmartLookup
POST/smart-lookups
Run quick background checks on a user's details.
Provide the user's details and the check(s) to run and receive the report.
First line of address should be taken from the results returned by the GET /postcode endpoint.
The supported checks are:
CreditBureauchecking credit reference agency data, plus public data like the electoral rollOnlineFootprintchecking against public traces of the user's online activityAMLchecking international sanctions database, watchlists and other lists of high-risk people
Caching and billing
To make it easier to test and demo, if you run the same smart lookup query within four hours, your results will be cached and you will not be charged again.
The billable field in the response body indicates whether tokens were charged for this call.
This endpoint supports sandbox mode. See how sandbox mode works.
Request
Responses
- 201
- 400
- 401
- 403
Performed successfully, report available
Bad request
Unauthorised
Feature not available on your plan - upgrade to Flex or higher