Multisig Wallets

Invite a member to enrol a signing key

Ask an organization member to hold one of the treasury signing keys, and email them about it. The invitation is a request, not a credential: it grants nothing, and the invitee still enrols under their own session and still gets validated out of band by a peer. Only an existing admin or owner can be invited — anyone else has no session to enrol with, so their invitation could never be honoured.

post/v1/multisig-wallets/{walletId}/invitations

Request

  • Base URL: https://api.prod.keyban.io
  • URL: https://api.prod.keyban.io/v1/multisig-wallets/{walletId}/invitations
  • Auth: one of:
    • API key in header X-Api-Key
    • bearer (a scheme the document does not define)

Path parameters

walletIdstring uuid required

The unique identifier of the multisig wallet

Request body

emailstring email required

Email of the organization member to invite. Must match an existing admin or owner of the organization: enrolment is the invitee’s own authenticated call, so anyone else would be handed an invitation they could never complete.

Example request

{
  "email": "jeanne.martin@example.com"
}

Response

Invitation recorded, and emailed to the member

idstring uuid required

Entity UUID

createdAtstring date-time required

Creation date (ISO 8601)

updatedAtstring date-time required

Last update date (ISO 8601)

consumedAtstring date-time nullable required

When the invitee enrolled a signing key, which closes the invitation. Null while it still stands. Consumed invitations are kept and still listed: they are the trace of who was asked to hold a key.

Example response

{
  "user": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Jeanne Martin",
    "email": "jeanne.martin@example.com",
    "image": "https://example.com/avatar.png"
  }
}

Changes

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