banking.v1.ConsiliumApprovalService

GetInvitation

The redacted invitation behind an emailed token. Side-effect free. Unknown, expired, spent and wrong-state tokens all return the SAME NOT_FOUND, so this cannot be used to probe which is which.

post/banking.v1.ConsiliumApprovalService/GetInvitation

Request

  • The document declares no server URL.
  • Auth: none required

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

tokenstring

The opaque single-use token from the mail. Never the code.

Response

Success

consilium_idstring
state'CONSILIUM_STATE_UNSPECIFIED' | 'CONSILIUM_STATE_OPEN' | 'CONSILIUM_STATE_APPROVED' | 'CONSILIUM_STATE_REJECTED' | 'CONSILIUM_STATE_EXPIRED' | 'CONSILIUM_STATE_CANCELLED' | 'CONSILIUM_STATE_EXECUTED' | 'CONSILIUM_STATE_EXECUTION_FAILED'

Where a consilium stands. Terminal everywhere except OPEN.

payload_hashstring
initiator_emailstring

Who opened it, masked.

voter_emailstring

The recipient's own masked address, so they can confirm the mail reached the right seat before typing the code.

thresholdinteger
approvalsinteger
owner_countinteger
decision'VOTE_DECISION_UNSPECIFIED' | 'VOTE_DECISION_PENDING' | 'VOTE_DECISION_APPROVE' | 'VOTE_DECISION_REJECT'

How one voter answered.

attempts_remaininginteger

Code attempts left before the token burns.

Changes

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