Skip to main content
POST
/
platform
/
admin
/
audit_registry
/
{smartContractImplementationBlockchainsDeployId}
/
add
Add implementation to audit registry
curl --request POST \
  --url https://api.example.com/platform/admin/audit_registry/{smartContractImplementationBlockchainsDeployId}/add \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

Creates a new audit registry entry that links a deployed smart contract implementation to its security audit report. This operation writes the audit information on-chain for transparency and verification purposes.

​
Input

Expects a JSON body containing:
  • auditRegistrySmartContractImplementationDeployId (long, required) — The audit registry deployment identifier (automatically populated from route).
  • selectedSmartContractImplementationDeployId (long, required) — The deployment ID of the smart contract being registered.
  • auditUrl (string, required) — HTTPS URL pointing to the security audit report document (PDF or web page).

​
Output

Returns a SuccessWithIdResponse object containing:
  • success (bool) — Indicates if the registration succeeded.
  • id (long) — The unique identifier of the created audit registry record.

​
Examples

Request 
POST /api/platform/audit-registry/42/add-implementation
{
  "selectedSmartContractImplementationDeployId": 77,
  "auditUrl": "https://audits.example.com/token-contract-v1-report.pdf"
}
Response (200 OK) 
{
  "success": true,
  "id": 156
}

​
Errors

  • 400 Bad Request: Invalid payload, missing required fields, or audit URL format is incorrect.
  • 401 Unauthorized: Caller is not authenticated.
  • 403 Forbidden: Caller lacks platform administration permissions.
  • 404 Not Found: The specified audit registry or smart contract deployment does not exist.
  • 500 Internal Server Error: Unexpected error occurred during registration.

​
Notes

This operation writes data to the blockchain and may take several seconds to complete. The audit URL must use HTTPS protocol and point to a publicly accessible document. Once registered, the audit information becomes part of the immutable on-chain record.

Path Parameters

​
smartContractImplementationBlockchainsDeployId
integer<int64>
required

The audit registry deployment identifier.

Query Parameters

​
api-version
string | null

Body

application/json

The audit registry implementation registration payload.

Request data for adding an audit registry implementation and also used to provide the information required by the UI when displaying the add implementation screen.

​
auditRegistrySmartContractImplementationDeployId
integer<int64>

Gets the deployment ID of the AuditRegistry.

Example:

42

​
selectedSmartContractImplementationDeployId
integer<int64>

Gets the deployment ID of the smart contract implementation selected to add to the AuditRegistry.

Example:

77

​
auditUrl
string

Gets the URL of the audit report when submitting a new implementation.

Example:

"https://audits.example.com/report.pdf"

Response

Implementation successfully added to audit registry.

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object

The result value returned when the operation is successful.