Record

Get recording or running status.

get

Get recording or running status. Policy must be in dry-run mode, otherwise returns 403 "Invalid status.". Only users with the Standard Registry role are allowed to make the request.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5

Responses

200

Successful operation.

application/json

typestringRequired

Record type (Recording or Running)

Example: Recording

policyIdstringRequired

Policy ID being recorded/run

Example: 69aeb71ef8c5b278e3bab4e5

uuidstringRequired

Unique identifier of the recording session

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147

statusstringRequired

Current status of the recording/running session

Example: New

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/record/{policyId}/status

HTTPcURLJavaScriptPython

GET /api/v1/record/{policyId}/status HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "type": "string",
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "status": "string"
}

Start recording.

post

Start recording. Only users with the Standard Registry role are allowed to make the request.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5

Body

application/json

object · ObjectOptional

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/record/{policyId}/recording/start

HTTPcURLJavaScriptPython

POST /api/v1/record/{policyId}/recording/start HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

true

Stop recording.

post

Stop recording. Only users with the Standard Registry role are allowed to make the request.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5

Body

application/json

object · ObjectOptional

Responses

200

Successful operation.

application/json

string · binaryOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/record/{policyId}/recording/stop

HTTPcURLJavaScriptPython

POST /api/v1/record/{policyId}/recording/stop HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "result": "ok"
}

Get recorded actions.

get

Get recorded actions. Only users with the Standard Registry role are allowed to make the request.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5

Responses

200

Successful operation.

application/json

uuidstringRequired

Unique identifier of the action

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147

policyIdstringRequired

Policy ID

Example: 69aeb71ef8c5b278e3bab4e5

methodstringRequired

HTTP method (GET, POST, PUT, etc.)

Example: POST

actionstringRequired

Action type

Example: CreateDID

timestringRequired

Timestamp when the action occurred

Example: 2026-03-03T17:25:53.312Z

userstringRequired

User DID who performed the action

Example: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599

targetstringRequired

Target block or entity of the action

Example: Block tag

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/record/{policyId}/recording/actions

HTTPcURLJavaScriptPython

GET /api/v1/record/{policyId}/recording/actions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
    "policyId": "69aeb71ef8c5b278e3bab4e5",
    "method": "string",
    "action": "string",
    "time": "string",
    "user": "string",
    "target": "string"
  }
]

Run record from a zip file.

post

Run record from a zip file. Only users with the Standard Registry role are allowed to make the request.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5

Query parameters

importRecordsstringRequired

syncNewRecordsstringRequired

fromPolicyIdstringRequired

Body

application/json

stringOptional

Responses

200

Record UUID.

application/json

stringOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/record/{policyId}/running/start

HTTPcURLJavaScriptPython

POST /api/v1/record/{policyId}/running/start?importRecords=text&syncNewRecords=text&fromPolicyId=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

string

Stop running.

post

Stop running. Only users with the Standard Registry role are allowed to make the request.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5

Body

application/json

object · ObjectOptional

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/record/{policyId}/running/stop

HTTPcURLJavaScriptPython

POST /api/v1/record/{policyId}/running/stop HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

true

Get running results.

get

Get running results. Only users with the Standard Registry role are allowed to make the request.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5

Responses

200

Successful operation.

application/json

totalnumberRequired

Total number of documents compared

Example: 5

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/record/{policyId}/running/results

HTTPcURLJavaScriptPython

GET /api/v1/record/{policyId}/running/results HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "info": {
    "tokens": "eyJhbGciOi...",
    "documents": 0
  },
  "total": 0,
  "documents": [
    {
      "type": "string",
      "schema": "string",
      "rate": "string",
      "documents": {}
    }
  ]
}

Get documents produced by a recorded action.

get

Returns all VC and VP documents from the dry-run store that share the given recordActionId. Only users with the Standard Registry role are allowed to make the request.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5

Query parameters

recordActionIdstringRequired

Record action UUID

Responses

200

Successful operation.

application/json

object[]Optional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/record/{policyId}/recording/action-documents

HTTPcURLJavaScriptPython

GET /api/v1/record/{policyId}/recording/action-documents?recordActionId=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {}
]

Get running details.

get

Get running details. Only users with the Standard Registry role are allowed to make the request.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5

Responses

200

Successful operation.

application/json

totalnumberRequired

Total number of fields compared

Example: 10

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/record/{policyId}/running/details

HTTPcURLJavaScriptPython

GET /api/v1/record/{policyId}/running/details HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "left": {},
  "right": {},
  "total": 0,
  "documents": {}
}

Fast Forward.

post

Fast Forward. Only users with the Standard Registry role are allowed to make the request.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5

Body

application/json

object · ObjectOptional

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/record/{policyId}/running/fast-forward

HTTPcURLJavaScriptPython

POST /api/v1/record/{policyId}/running/fast-forward HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

true

Retry step.

post

Retry step. Only users with the Standard Registry role are allowed to make the request.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5

Body

application/json

object · ObjectOptional

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/record/{policyId}/running/retry

HTTPcURLJavaScriptPython

POST /api/v1/record/{policyId}/running/retry HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

true

Skip step.

post

Skip step. Only users with the Standard Registry role are allowed to make the request.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5

Body

application/json

object · ObjectOptional

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/record/{policyId}/running/skip

HTTPcURLJavaScriptPython

POST /api/v1/record/{policyId}/running/skip HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

true