Sign in

Retrieve a mandate

Poll this endpoint to check whether the human has approved the mandate (status: active). Also use it to check remaining budget and expiry before requesting a credential.

get/mandates/{id}

Path parameters

idstring required

Mandate ID (prefix: mnd_)

Response

Mandate retrieved

idstring required

Unique mandate ID.

owner_idstring required

ID of the human user who owns and approved this mandate.

agent_idstring required

ID of the AI agent authorized to request credentials under this mandate.

status'pending_approval' | 'active' | 'exhausted' | 'expired' | 'revoked' required

pending_approval = created, awaiting human approval. active = approved, credential requests accepted. exhausted = once mandate fully used. expired = past expires_at. revoked = manually cancelled.

approved_atstring date-time nullable

When the human owner approved the mandate.

created_atstring date-time required
expires_atstring date-time nullable
metadataobject

Up to 10 key-value string pairs. Use to record user instruction, task context, etc.

x-ap2-notestring

In a future AP2-compatible version, this mandate will be issued as a signed Intent Mandate VDC and approved_at will carry a cryptographic attestation.

Changes