OpenAPI and Postman

The BV API as an OpenAPI 3.1 description, to import into Postman, generate a client, or test against.

The whole API — endpoints, parameters, result objects, errors and authentication — is described in one OpenAPI 3.1 file:

It is checked against the live API's answers when it changes.

Postman

The collection is in bklink's public Postman workspace: postman.com/bklink1/bklink-s-workspace.

Fork the mxverify BV API collection into your own workspace.
Make an environment with a variable bearerToken (type secret) set to your key from bklink.uk/api-keys. The collection sends it as Authorization: Bearer {{bearerToken}}; baseUrl is already https://mxverify.uk.
Send Look up one site.

To build the collection yourself instead, choose Import in Postman and paste https://bklink.uk/docs/openapi.json.

Any OpenAPI 3.1 generator works. For example, TypeScript types:

npx openapi-typescript https://bklink.uk/docs/openapi.json -o mxverify-bv.d.ts

The file's info.version follows the API: 1.x for /api/v1. Changes are listed in the changelog.