Minka Ledger Docs
ReferencesApi referenceCircleSigners

Assign a signer to a circle

Circles describes roles or groups of signers.

POST
/circles/{id}/signers

Authorization

AuthorizationRequiredBearer <token>

JWT signed by private key. The presence of this token is not mandatory. It becomes required through the configuration of authorization access rules that requires a token to grant access. Once sent, the token is validated for its format, signature and expiration, regardless of the presence of access rules.

In: header

Request Body

application/jsonRequired

Circle signer body

hashRequiredstring
Pattern: "^[A-Fa-f0-9]{64}$"
metaRequiredobject
dataRequiredobject

Path Parameters

idRequiredstring | string

The unique identifier of the record - its luid or address.

Header Parameters

x-ledgerstring | string

The unique identifier of ledger in context for multi tenant requests.

curl -X POST "http://localhost:3000/v2/circles/tran:12345@pbz.hr/signers" \
  -H "x-ledger: bog" \
  -H "Content-Type: application/json" \
  -d '{
    "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
    "meta": {
      "proofs": [
        {
          "method": "ed25519-v2",
          "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
          "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
          "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ==",
          "custom": {
            "moment": "2019-01-01T00:00:00.000Z",
            "type": "PERSON",
            "reference": 3284759238475
          }
        }
      ]
    },
    "data": {
      "schema": "tran:12345@pbz.hr",
      "circle": "tran:12345@pbz.hr",
      "signer": "tran:12345@pbz.hr",
      "custom": {
        "type": "PERSON",
        "reference": 3284759238475
      }
    }
  }'

Assigned circle signer

{
  "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
        "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
        "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ==",
        "custom": {
          "moment": "2019-01-01T00:00:00.000Z",
          "type": "PERSON",
          "reference": 3284759238475
        }
      }
    ],
    "owners": [
      "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE="
    ],
    "moment": "2019-08-24T14:15:22Z",
    "status": "string",
    "labels": [
      "preferred"
    ]
  },
  "luid": "$wlt.7mSVWFKX-Tfx2NsNj",
  "data": {
    "schema": "tran:12345@pbz.hr",
    "circle": "tran:12345@pbz.hr",
    "signer": "tran:12345@pbz.hr",
    "custom": {
      "type": "PERSON",
      "reference": 3284759238475
    }
  }
}