HITL

Finalize HITL config

Transition a pending HITL configuration to active. Requires an uploaded encryption keypair. Creates authorizations for configured channels and dispatches consent messages.

post/api/v1/hitl/{id}/finalize

Request

  • Base URL: https://api.proof.holdings
  • URL: https://api.proof.holdings/api/v1/hitl/{id}/finalize
  • Auth: HTTP bearer

Path parameters

idstring required

MongoDB ObjectId

Example:507f1f77bcf86cd799439011

Response

HITL config finalized (pending → active)

idstring required

MongoDB ObjectId

user_idstring required

MongoDB ObjectId

namestring nullable
profile_idstring

MongoDB ObjectId

circle_idstring

MongoDB ObjectId

timeout_secondsinteger required
status'pending' | 'active' | 'archived' required

Status of a HITL configuration

environment'production' | 'test' required
created_atstring date-time required
updated_atstring date-time required

Example response

{
  "id": "507f1f77bcf86cd799439011",
  "user_id": "507f1f77bcf86cd799439011",
  "name": "Production Approvals",
  "profile_id": "507f1f77bcf86cd799439011",
  "circle_id": "507f1f77bcf86cd799439011",
  "channels": [
    {
      "config": {
        "chat_id": "123456789"
      }
    }
  ],
  "timeout_seconds": 3600,
  "status": "active",
  "environment": "production",
  "authorizations": [
    {
      "channel": "telegram",
      "authorization_id": "507f1f77bcf86cd799439011",
      "status": "pending"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.