To send and API request, you can create a service account (which is a bit like a user account) within your organisation. You can then set its permissions. For example, a service account might be permitted to issue certificates from a particular scheme.
Within a service account, you can create and name one or more API keys. These behave like passwords to authenticate the service account when it makes a request. The API key is presented as an X-Org-Token in the request header.
It is good practice to restrict the permissions of an API service account to only those that are needed. You should also keep your API keys secret and only share then with people you trust, for example an IT consultant setting up your APIs.
For logged in users, we have more detailed API schema information available here. We also have some other API endpoints available for other features, so do let us know if there is another specific task you'd like to perform and we'll be happy to help.
These service account APIs help to automate what would otherwise be a manual search for public information on BlockMark Registry.
Search Public Certificates of an Organisation You can send either the exact (case-insensitive) organisation name or its BlockMark Registry ID (e.g. ’BlockMark Technologies Ltd or ‘GBLTD10821944’). The response will be a list of their public certificates and some associated information, if any. The results are paginated as 10 certificates per page. Each page that contains any results is charged as per the Advanced Service Account API service.
Search Public Organisations You can send a search string to return up to 10 close matches of an organisation name / trading name / previous name / name on associated (public) certificate. The response will be the organisation name, the organisation ID and the organisation profile page. Each page that contains any results is charged as per the Advanced Service Account API service.
Search Organisations associated with your Issued Certificates As the issuer of a certificate to an organisation, you can send the certificate ID and this will return the organisation name and organisation ID the certificate was issued to. This is useful to synchronise your records where we have dealt with duplicate organisations being given different organisation IDs, etc. Each result is charged as per the Advanced Service Account API service.
We'll be adding more details here soon...