Skip to main content

Postman Collection

Try out the API without writing code.

The dilisense Postman collection contains a request for every endpoint of the API Reference, organized in one folder per API. The requests are filled in with the example values of the reference, and most of them come with an example response, so you can send your first call with a few clicks.

The collection is generated from the OpenAPI specification and always matches the current API.

Download: dilisense-api.postman_collection.json

Set-Up Guide​

1. Get your API key​

Sign in to your dilisense account and copy the API key from the dashboard. If you do not have an account yet, you can create one there; 100 API calls per month are free, no credit card required.

2. Import the collection​

In Postman, click Import and either drop the downloaded file into the dialog or paste the link of the collection:

https://developers.dilisense.com/dilisense-api.postman_collection.json

The collection appears as dilisense API in your workspace.

3. Add your API key​

Select the collection, open the Variables tab and set the value of the apiKey variable to your API key. Save the collection. Every request sends the variable in the x-api-key header, see Authentication.

info

Keep the API key out of collections that you share or export. If you share the collection with your team, store the key in a Postman environment or vault instead.

4. Send a request​

Open, for example, AML Screening > Screen an individual and click Send. The response appears below the request; the saved example response is listed under the request in the sidebar.

Additional Notes​

  • Only the query parameters with an example value are enabled. The others are listed but disabled, tick them in the Params tab to use them. Some parameters cannot be combined, e.g. names and search_all, see the API Reference for each parameter.
  • Requests from Postman count towards your quotas like any other API call, see Quotas.
  • The base URL is set by the baseUrl collection variable (https://api.dilisense.com).
  • When the API changes, download and import the collection again to get the new endpoints and parameters.