Skip to main content

InstructionResponse

@mandaitor/sdk

@mandaitor/sdk / InstructionResponse

Interface: InstructionResponse

Defined in: @mandaitor/sdk/dist/types.d.ts:236

Experimental

Response from GET /mandates/{id}/instruction. Contains the decrypted instruction text and metadata. Calling this endpoint creates an INSTRUCTION_REVEALED audit event.

Properties​

instruction_channel​

instruction_channel: InstructionChannel

Defined in: @mandaitor/sdk/dist/types.d.ts:244

Experimental

Channel through which the instruction was received

instruction_hash​

instruction_hash: string

Defined in: @mandaitor/sdk/dist/types.d.ts:240

Experimental

SHA-256 hex digest of the instruction text

instruction_text​

instruction_text: string

Defined in: @mandaitor/sdk/dist/types.d.ts:238

Experimental

Decrypted original instruction text

instruction_timestamp​

instruction_timestamp: string

Defined in: @mandaitor/sdk/dist/types.d.ts:242

Experimental

ISO 8601 timestamp when the instruction was captured

mandate_id​

mandate_id: string

Defined in: @mandaitor/sdk/dist/types.d.ts:252

Experimental

Mandate ID this instruction belongs to

principal_confirmation​

principal_confirmation: object

Defined in: @mandaitor/sdk/dist/types.d.ts:246

Experimental

How the principal confirmed the instruction

evidence_ref?​

optional evidence_ref?: string

method​

method: ConfirmationMethod

timestamp​

timestamp: string