logo
API Reference
Test API Endpoint
Generate Checksum
Generate Certificate ID
Get Certificate
Get Certificate Language
Create Certificate
Update Certificate
Batch Delete Certificates
API Key
powered by zuplo

ScoreDetect API

Welcome to the ScoreDetect API! You can use this documentation during the setup of your integration. To begin, you will need to obtain an API key here.

BASE URL
https://api.scoredetect.com

Test API Endpoint

For developers only. This is a test API endpoint during the configuration of your custom integration with the ScoreDetect API.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

GET
/me
1

Generate Checksum

Generates a SHA-256 checksum hash. Requires a form-data key called file which accepts either a File or Text input type. Once added, the API takes in the input and performs a SHA-256 hash function, and returns a JSON object of the checksum value.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

POST
/generate-checksum
1

Generate Certificate ID

Generates a valid unique certificate ID. This can be useful for preparing the certificate ID, for example, before a blockchain transaction is made.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

POST
/generate-certificate-id
1

Get Certificate

Specify the certificate ID (uuid) to fetch from with the ?id= query string parameter.

GET
/get-certificate
1

Get Certificate Language

Specify the certificate ID (uuid) to fetch from with the ?id= query string parameter.

GET
/get-certificate-language
1

Create Certificate

The certificate requires a form-data key called hash which accepts a 64-character SHA-256 hash string. However, our legacy feature also provides a key called file which accepts either a File or Text input type. Once added, the API uses the hash, or takes in the input file and performs a SHA-256 hash function before sending it to the blockchain. This ensures a "privacy-first" approach. We recommend using sending the request with the hash key for unlimited file size and optimum security best practices.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

POST
/create-certificate
1

Update Certificate

The certificate metadata (not the blockchain transaction) can be updated by adding the body as a JSON stringified object containing 2 properties: the certificateId (the certificate ID) and metadata (an object containing e.g. { "username": "anonymous", "certificateType": "plain_text_upload", "displayCreatedBy": false }. The username is the ScoreDetect username (default is anonymous), certificateType accepts 2 values: plain_text_upload or file_upload, and displayCreatedBy accepts a boolean value of true or false.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

PATCH
/update-certificate
1

Batch Delete Certificates

Add 1 or more "certificateIds" in an array, as a raw body JSON for example { "certificateIds": [ "12345678-1234-1234-1234-123456789012", "22345678-1234-1234-1234-123456789012" ] }. Once the certificate is deleted, the response will return the deleted certificate IDs.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

DELETE
/certificates/batch-delete
1
Protected by API Key
Protected by API Key
Protected by API Key
Protected by API Key
Protected by API Key
Protected by API Key