Notarizations
This endpoint retrieves all notarizations associated with a specific Digital Product Passport (DPP) identified by dppId. The response includes blockchain transaction data, a history of associated files, and technical cards linked to the DPP.
1. View DPP Notarizations
GET /view-dpp-notarizations/:dppId
Description: Retrieves all notarizations for a given Digital Product Passport (DPP) identified by dppId
. This includes the corresponding blockchain transaction data and the history of files and technical cards associated with the DPP.
Parameters:
- dppId: The ID of the DPP for which notarizations are being retrieved.
Response
Status | Description |
---|---|
200 OK | Successfully retrieved the notarizations along with related receipts and history data. |
500 Internal Server Error | An unexpected error occurred while fetching the notarization data. |
Response Object:
{
"notarizations": [
{
"id": "string",
"dpp_hash": "string",
"created_at": "string",
"version": "integer",
"to": "string",
"from": "string",
"transaction_hash": "string",
"block_hash": "string",
"block_number": "integer",
"url": "string",
"dpp": {
"id": "string",
"files": [
{
"id": "string",
"file_name": "string",
"file_url": "string"
}
],
"cards": [
{
"id": "string",
"name": "string",
"characteristics": [
{
"id": "string",
"name": "string",
"value": "string"
}
]
}
]
}
}
]
}
2. Notarize DPP
POST /version/:dppId/notarize
Description: Finalizes the notarization process for a DPP, including uploading a frontend-generated report and updating the DPP version with the provided blockchain hash, signature, and other metadata.
Parameters:
- dppId: The ID of the DPP to be notarized.
Request Body:
{
"file": "file",
"companyId": "uuid",
"hash": "string",
"signature": "string",
"submitter": "string",
"filesList": "string"
}
Response
Status | Description |
---|---|
200 OK | The DPP version data after a successful notarization. |
400 Bad Request | Invalid file format or request data. |
500 Internal Server Error | An error occurred during the notarization process. |
Response Object:
{
"id": "string",
"status": "READY",
"hash": "string",
"signature": "string",
"submitter": "string",
"uri": "string"
}