> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gol.network/llms.txt
> Use this file to discover all available pages before exploring further.

# Get v1mandate requests

> Owning browser or creator agent only; OAuth account:read. Independently reconciles the exact approval; browser callbacks and hashes are not completion evidence.



## OpenAPI

````yaml /openapi/platform.json get /v1/mandate-requests/{id}
openapi: 3.1.0
info:
  title: GOL Platform API
  description: >-
    Versioned GOL developer and consumer API. Consumer routes are mounted when
    their runtime integrations are configured.
  version: 0.8.0-rc.1
servers:
  - url: http://localhost:4100
    description: Local development
security: []
tags:
  - name: system
  - name: authentication
  - name: projects
  - name: api-keys
  - name: audit
  - name: gas-executions
  - name: gas-policies
  - name: webhooks
paths:
  /v1/mandate-requests/{id}:
    get:
      tags:
        - Canonical mandate requests
      description: >-
        Owning browser or creator agent only; OAuth account:read. Independently
        reconciles the exact approval; browser callbacks and hashes are not
        completion evidence.
      operationId: getCanonicalMandateRequest
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            pattern: ^mr_[0-9a-f]{32}$
      responses:
        '200':
          description: Canonical mandate request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CanonicalMandateRecord'
        '400':
          description: Request refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerError'
        '401':
          description: Request refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerError'
        '403':
          description: Request refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerError'
        '404':
          description: Request refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerError'
        '409':
          description: Request refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerError'
        '503':
          description: Request refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerError'
      security:
        - bearerAuth: []
components:
  schemas:
    CanonicalMandateRecord:
      type: object
      properties:
        schemaVersion:
          type: integer
          enum:
            - 1
        id:
          type: string
          pattern: ^mr_[0-9a-f]{32}$
        status:
          type: string
          enum:
            - pending
            - opened
            - observing
            - confirmed
            - rejected
            - expired
            - failed
        intent:
          $ref: '#/components/schemas/CanonicalMandateIntent'
        createdAt:
          format: date-time
          type: string
        expiresAt:
          format: date-time
          type: string
        account:
          type: object
          properties:
            id:
              type: string
            address:
              pattern: ^0x[0-9a-fA-F]{40}$
              type: string
            chainId:
              type: integer
              enum:
                - 84532
          required:
            - id
            - address
            - chainId
          additionalProperties: false
        agent:
          type: object
          properties:
            id:
              type: string
            address:
              pattern: ^0x[0-9a-fA-F]{40}$
              type: string
          required:
            - id
            - address
          additionalProperties: false
        preparation:
          oneOf:
            - $ref: '#/components/schemas/CanonicalMandatePreparation'
            - type: 'null'
        confirmation:
          oneOf:
            - $ref: '#/components/schemas/def-6'
            - type: 'null'
        transactionHash:
          oneOf:
            - pattern: ^0x[0-9a-fA-F]{64}$
              type: string
            - type: 'null'
      required:
        - schemaVersion
        - id
        - status
        - intent
        - createdAt
        - expiresAt
        - account
        - agent
        - preparation
        - confirmation
        - transactionHash
      additionalProperties: false
    ConsumerError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - invalid_request
                - unauthorized
                - forbidden
                - not_found
                - rate_limited
                - service_unavailable
                - internal_error
                - capability_unavailable
                - conflict
            message:
              type: string
            correlationId:
              type: string
          required:
            - code
            - message
            - correlationId
      required:
        - error
    CanonicalMandateIntent:
      type: object
      properties:
        schemaVersion:
          type: integer
          enum:
            - 1
        kind:
          type: string
          enum:
            - mandate.gas-policy.approve
        chainId:
          type: integer
          enum:
            - 84532
        agentAddress:
          pattern: ^0x[0-9a-fA-F]{40}$
          type: string
        recipients:
          type: array
          items:
            pattern: ^0x[0-9a-fA-F]{40}$
            type: string
          minItems: 1
          maxItems: 16
          uniqueItems: true
        maxPerActionBaseUnits:
          type: string
          pattern: ^[1-9][0-9]*$
        maxTotalBaseUnits:
          type: string
          pattern: ^[1-9][0-9]*$
        maxGasPerActionWei:
          type: string
          pattern: ^[1-9][0-9]*$
        maxGasTotalWei:
          type: string
          pattern: ^[1-9][0-9]*$
        expiresAt:
          minimum: 1
          type: integer
        idempotencyKey:
          format: uuid
          type: string
      required:
        - schemaVersion
        - kind
        - chainId
        - agentAddress
        - recipients
        - maxPerActionBaseUnits
        - maxTotalBaseUnits
        - maxGasPerActionWei
        - maxGasTotalWei
        - expiresAt
        - idempotencyKey
      additionalProperties: false
    CanonicalMandatePreparation:
      type: object
      properties:
        schemaVersion:
          type: integer
          enum:
            - 1
        preparationId:
          format: uuid
          type: string
        requestId:
          type: string
          pattern: ^mr_[0-9a-f]{32}$
        intentHash:
          pattern: ^0x[0-9a-fA-F]{64}$
          type: string
        preparedAt:
          format: date-time
          type: string
        projectId:
          format: uuid
          type: string
        prepared:
          additionalProperties: false
          type: object
          required:
            - draftId
            - draftExpiresAt
            - environment
            - chainId
            - core
            - account
            - family
            - review
            - authority
            - signing
            - submission
          properties:
            draftId:
              format: uuid
              type: string
            draftExpiresAt:
              format: date-time
              type: string
            environment:
              type: string
              enum:
                - test
            chainId:
              type: number
              enum:
                - 84532
            core:
              pattern: ^0x[0-9a-fA-F]{40}$
              type: string
            account:
              pattern: ^0x[0-9a-fA-F]{40}$
              type: string
            family:
              anyOf:
                - type: string
                  enum:
                    - safe
                - type: string
                  enum:
                    - nexus
                - type: string
                  enum:
                    - kernel
                - type: string
                  enum:
                    - alchemy
                - type: string
                  enum:
                    - nexus7702
            review:
              additionalProperties: false
              type: object
              required:
                - projectId
                - contractProjectId
                - agent
                - asset
                - assetDecimals
                - recipients
                - maxPerActionBaseUnits
                - maxTotalBaseUnits
                - relayerMode
                - submitter
                - gasRecipient
                - attester
                - maxGasPerActionWei
                - maxGasTotalWei
                - chargeableOutcomesMask
                - maxDepth
                - maxActiveDescendants
                - mandateValidFrom
                - mandateExpiresAt
                - gasExpiresAt
              properties:
                projectId:
                  format: uuid
                  type: string
                contractProjectId:
                  pattern: ^0x[0-9a-fA-F]{64}$
                  type: string
                agent:
                  pattern: ^0x[0-9a-fA-F]{40}$
                  type: string
                asset:
                  pattern: ^0x[0-9a-fA-F]{40}$
                  type: string
                assetDecimals:
                  type: number
                  enum:
                    - 6
                recipients:
                  type: array
                  items:
                    pattern: ^0x[0-9a-fA-F]{40}$
                    type: string
                maxPerActionBaseUnits:
                  pattern: ^(0|[1-9][0-9]{0,77})$
                  type: string
                maxTotalBaseUnits:
                  pattern: ^(0|[1-9][0-9]{0,77})$
                  type: string
                relayerMode:
                  anyOf:
                    - type: string
                      enum:
                        - gol
                    - type: string
                      enum:
                        - developer
                submitter:
                  pattern: ^0x[0-9a-fA-F]{40}$
                  type: string
                gasRecipient:
                  pattern: ^0x[0-9a-fA-F]{40}$
                  type: string
                attester:
                  pattern: ^0x[0-9a-fA-F]{40}$
                  type: string
                maxGasPerActionWei:
                  pattern: ^(0|[1-9][0-9]{0,77})$
                  type: string
                maxGasTotalWei:
                  pattern: ^(0|[1-9][0-9]{0,77})$
                  type: string
                chargeableOutcomesMask:
                  minimum: 0
                  type: integer
                maxDepth:
                  minimum: 0
                  type: integer
                maxActiveDescendants:
                  minimum: 0
                  type: integer
                mandateValidFrom:
                  minimum: 0
                  type: integer
                mandateExpiresAt:
                  minimum: 0
                  type: integer
                gasExpiresAt:
                  minimum: 0
                  type: integer
            authority:
              additionalProperties: false
              type: object
              required:
                - mandateTerms
                - mandatePolicy
                - gasPolicy
                - mandateId
                - gasPolicyId
                - combinedDigest
              properties:
                mandateTerms:
                  additionalProperties: false
                  type: object
                  required:
                    - parentId
                    - account
                    - agent
                    - accountProfileId
                    - installEpoch
                    - projectId
                    - mode
                    - policyVersion
                    - policyHash
                    - validFrom
                    - expiresAt
                    - maxDepth
                    - maxActiveDescendants
                    - approvalExpiresAt
                    - salt
                  properties:
                    parentId:
                      pattern: ^0x[0-9a-fA-F]{64}$
                      type: string
                    account:
                      pattern: ^0x[0-9a-fA-F]{40}$
                      type: string
                    agent:
                      pattern: ^0x[0-9a-fA-F]{40}$
                      type: string
                    accountProfileId:
                      pattern: ^0x[0-9a-fA-F]{64}$
                      type: string
                    installEpoch:
                      pattern: ^(0|[1-9][0-9]{0,77})$
                      type: string
                    projectId:
                      pattern: ^0x[0-9a-fA-F]{64}$
                      type: string
                    mode:
                      minimum: 0
                      type: integer
                    policyVersion:
                      minimum: 0
                      type: integer
                    policyHash:
                      pattern: ^0x[0-9a-fA-F]{64}$
                      type: string
                    validFrom:
                      minimum: 0
                      type: integer
                    expiresAt:
                      minimum: 0
                      type: integer
                    maxDepth:
                      minimum: 0
                      type: integer
                    maxActiveDescendants:
                      minimum: 0
                      type: integer
                    approvalExpiresAt:
                      minimum: 0
                      type: integer
                    salt:
                      pattern: ^0x[0-9a-fA-F]{64}$
                      type: string
                mandatePolicy:
                  pattern: ^0x([0-9a-f]{2})+$
                  type: string
                gasPolicy:
                  additionalProperties: false
                  type: object
                  required:
                    - mandateId
                    - account
                    - projectId
                    - accountProfileId
                    - installEpoch
                    - feeAsset
                    - submitter
                    - recipient
                    - attester
                    - maxPerAction
                    - maxTotal
                    - expiresAt
                    - chargeableOutcomes
                    - formulaVersion
                    - nonce
                  properties:
                    mandateId:
                      pattern: ^0x[0-9a-fA-F]{64}$
                      type: string
                    account:
                      pattern: ^0x[0-9a-fA-F]{40}$
                      type: string
                    projectId:
                      pattern: ^0x[0-9a-fA-F]{64}$
                      type: string
                    accountProfileId:
                      pattern: ^0x[0-9a-fA-F]{64}$
                      type: string
                    installEpoch:
                      pattern: ^(0|[1-9][0-9]{0,77})$
                      type: string
                    feeAsset:
                      pattern: ^0x[0-9a-fA-F]{40}$
                      type: string
                    submitter:
                      pattern: ^0x[0-9a-fA-F]{40}$
                      type: string
                    recipient:
                      pattern: ^0x[0-9a-fA-F]{40}$
                      type: string
                    attester:
                      pattern: ^0x[0-9a-fA-F]{40}$
                      type: string
                    maxPerAction:
                      pattern: ^(0|[1-9][0-9]{0,77})$
                      type: string
                    maxTotal:
                      pattern: ^(0|[1-9][0-9]{0,77})$
                      type: string
                    expiresAt:
                      minimum: 0
                      type: integer
                    chargeableOutcomes:
                      minimum: 0
                      type: integer
                    formulaVersion:
                      minimum: 0
                      type: integer
                    nonce:
                      pattern: ^(0|[1-9][0-9]{0,77})$
                      type: string
                mandateId:
                  pattern: ^0x[0-9a-fA-F]{64}$
                  type: string
                gasPolicyId:
                  pattern: ^0x[0-9a-fA-F]{64}$
                  type: string
                combinedDigest:
                  pattern: ^0x[0-9a-fA-F]{64}$
                  type: string
            signing:
              $ref: '#/components/schemas/def-5'
            submission:
              additionalProperties: false
              type: object
              required:
                - to
                - functionName
              properties:
                to:
                  pattern: ^0x[0-9a-fA-F]{40}$
                  type: string
                functionName:
                  type: string
                  enum:
                    - createMandateWithGas
      required:
        - schemaVersion
        - preparationId
        - requestId
        - intentHash
        - preparedAt
        - projectId
        - prepared
      additionalProperties: false
    def-6:
      additionalProperties: false
      type: object
      required:
        - gasPolicyId
        - mandateId
        - account
        - family
        - agent
        - status
        - maxPerActionWei
        - maxTotalWei
        - spentWei
        - remainingWei
        - expiresAt
        - chargeableOutcomesMask
        - recipient
        - attester
        - relayerMode
        - submitter
        - formulaVersion
        - maxDepth
        - maxActiveDescendants
        - activeDescendants
        - approvalTransactionHash
        - revocationTransactionHash
        - observedBlockNumber
        - createdAt
        - updatedAt
      properties:
        gasPolicyId:
          pattern: ^0x[0-9a-fA-F]{64}$
          type: string
        mandateId:
          pattern: ^0x[0-9a-fA-F]{64}$
          type: string
        account:
          pattern: ^0x[0-9a-fA-F]{40}$
          type: string
        family:
          anyOf:
            - anyOf:
                - type: string
                  enum:
                    - safe
                - type: string
                  enum:
                    - nexus
                - type: string
                  enum:
                    - kernel
                - type: string
                  enum:
                    - alchemy
                - type: string
                  enum:
                    - nexus7702
            - type: 'null'
        agent:
          pattern: ^0x[0-9a-fA-F]{40}$
          type: string
        status:
          anyOf:
            - type: string
              enum:
                - active
            - type: string
              enum:
                - paused
            - type: string
              enum:
                - revoked
            - type: string
              enum:
                - expired
            - type: string
              enum:
                - unavailable
        maxPerActionWei:
          pattern: ^(0|[1-9][0-9]{0,77})$
          type: string
        maxTotalWei:
          pattern: ^(0|[1-9][0-9]{0,77})$
          type: string
        spentWei:
          pattern: ^(0|[1-9][0-9]{0,77})$
          type: string
        remainingWei:
          pattern: ^(0|[1-9][0-9]{0,77})$
          type: string
        expiresAt:
          type: integer
        chargeableOutcomesMask:
          type: integer
        recipient:
          pattern: ^0x[0-9a-fA-F]{40}$
          type: string
        attester:
          pattern: ^0x[0-9a-fA-F]{40}$
          type: string
        relayerMode:
          anyOf:
            - type: string
              enum:
                - gol
            - type: string
              enum:
                - developer
        submitter:
          pattern: ^0x[0-9a-fA-F]{40}$
          type: string
        formulaVersion:
          type: integer
        maxDepth:
          type: integer
        maxActiveDescendants:
          type: integer
        activeDescendants:
          type: integer
        approvalTransactionHash:
          anyOf:
            - pattern: ^0x[0-9a-fA-F]{64}$
              type: string
            - type: 'null'
        revocationTransactionHash:
          anyOf:
            - pattern: ^0x[0-9a-fA-F]{64}$
              type: string
            - type: 'null'
        observedBlockNumber:
          pattern: ^(0|[1-9][0-9]{0,77})$
          type: string
        createdAt:
          format: date-time
          type: string
        updatedAt:
          format: date-time
          type: string
      title: GasPolicyRecord
    def-5:
      additionalProperties: false
      type: object
      required:
        - family
        - method
        - typedData
        - expectedHash
        - digest
        - signatureFormat
      properties:
        family:
          anyOf:
            - type: string
              enum:
                - safe
            - type: string
              enum:
                - nexus
            - type: string
              enum:
                - kernel
            - type: string
              enum:
                - alchemy
            - type: string
              enum:
                - nexus7702
        method:
          type: string
          enum:
            - eth_signTypedData_v4
        typedData:
          additionalProperties: false
          type: object
          required:
            - domain
            - types
            - primaryType
            - message
          properties:
            domain:
              type: object
              additionalProperties: {}
            types:
              type: object
              additionalProperties:
                type: array
                items:
                  type: object
                  required:
                    - name
                    - type
                  properties:
                    name:
                      type: string
                    type:
                      type: string
            primaryType:
              type: string
            message:
              type: object
              additionalProperties: {}
        expectedHash:
          pattern: ^0x[0-9a-fA-F]{64}$
          type: string
        digest:
          pattern: ^0x[0-9a-fA-F]{64}$
          type: string
        signatureFormat:
          anyOf:
            - type: string
              enum:
                - safe_threshold
            - type: string
              enum:
                - nexus_k1
            - type: string
              enum:
                - kernel_root
            - type: string
              enum:
                - alchemy_entity_zero
            - type: string
              enum:
                - eoa
      title: WalletSigningPayload
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Opaque owner, CLI, or agent session token. Agent tokens are accepted
        only where marked.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.