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

# Read your own registration with your app key

> The self-read: the app's own registration, answered to the credential the app already holds. Registration metadata only — the values the developer registered, plus the console origin and endpoint paths an SDK needs to run the whole handshake without being separately configured with any of them.



## OpenAPI

````yaml /api-reference/openapi.yaml get /connect/apps/me
openapi: 3.0.3
info:
  title: Payman Connect API
  version: 0.1.0
  description: >-
    The HTTP contract behind Payman Connect: exchange a customer's consent for a
    grant, send actions against the accounts it reaches, and follow an approval
    to its receipt. Every call carries your app key, and every call after the
    exchange carries the grant. Non-2xx responses share one `ApiError` envelope.
    Most integrations never write these calls: the SDK speaks them for you.
servers:
  - url: https://api.paygent.payman.ai
    description: Production
  - url: http://localhost:8891
    description: A local stack
security:
  - bearerAuth: []
tags:
  - name: Connect
    description: >-
      Third-party access. A registered app presents its app key together with a
      grant token its customer consented to; the pair reaches exactly the one
      deployment the grant names, and nothing else on this API.
paths:
  /connect/apps/me:
    get:
      tags:
        - Connect
      summary: Read your own registration with your app key
      description: >-
        The self-read: the app's own registration, answered to the credential
        the app already holds. Registration metadata only — the values the
        developer registered, plus the console origin and endpoint paths an SDK
        needs to run the whole handshake without being separately configured
        with any of them.
      operationId: getConnectAppSelf
      responses:
        '200':
          description: The registration, as the key's holder may see it
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectAppSelf'
        '401':
          description: >-
            `invalid_connect_credentials` — an app key that is missing, unknown,
            revoked or expired. The state of your OWN credential is named in
            `details.reason` when that is what failed: `app_expired` (renew the
            registration) or `app_revoked` (re-register).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
        - connectAppKey: []
components:
  schemas:
    ConnectAppSelf:
      type: object
      required:
        - appId
        - name
        - environment
        - redirectUris
        - expiresAt
        - consoleOrigin
        - authorizeUrl
        - tokenUrl
        - toolDefinitionUrl
      description: >-
        The self-read (`GET /connect/apps/me`): registration metadata plus the
        discovery an SDK boots from, and nothing else.
      properties:
        appId:
          type: string
          format: uuid
        name:
          type: string
          description: What your customers' consent page shows as "… wants access".
        environment:
          $ref: '#/components/schemas/ConnectEnvironment'
        redirectUris:
          type: array
          items:
            type: string
          description: >-
            The registered list, exactly as authorize and the exchange will
            byte-compare it. This is the value an SDK should derive its callback
            handling from, in place of a separately configured copy.
        expiresAt:
          type: string
          format: date-time
          description: >-
            When this registration ages out. An SDK's doctor check warns from
            this; renewing is a console (session) action.
        consoleOrigin:
          type: string
          nullable: true
          description: >-
            The consumer console's origin — where consent and approvals are
            collected. The same configuration approval URLs are minted from, and
            null under the same missing configuration.
        authorizeUrl:
          type: string
          nullable: true
          description: The consent page on that origin. Null when `consoleOrigin` is.
        tokenUrl:
          type: string
          description: Path of the token exchange, relative to this server's origin.
        toolDefinitionUrl:
          type: string
          description: >-
            Path of the served tool definition, relative to this server's
            origin.
    ApiError:
      type: object
      required:
        - category
        - code
        - message
      description: >-
        The envelope every non-2xx response uses. `code` is a stable slug a
        client can match on exactly; `message` is safe to show a user as-is.
      properties:
        category:
          $ref: '#/components/schemas/ApiErrorCategory'
        code:
          type: string
          example: agent_not_configured
        message:
          type: string
          example: Configure this agent before sending it messages.
        details:
          type: object
          additionalProperties: true
          nullable: true
          description: >-
            Structured context — field errors, the agent's own status, and so
            on.
    ConnectEnvironment:
      type: string
      enum:
        - sandbox
        - live
      description: >-
        Which world a Connect app lives in. `sandbox` — the Durango demo bank,
        where nothing is money; a sandbox app may declare only DURANGO agents
        and its credentials are minted as `pgc_app_test_…` / `pgc_grant_test_…`.
        `live` — everything else; a live app cannot declare DURANGO agents.
    ApiErrorCategory:
      type: string
      description: >-
        Fixed taxonomy, matching K2's so a client that already handles K2 errors
        handles these too.
      enum:
        - VALIDATION
        - AUTH
        - PERMISSION
        - NOT_FOUND
        - CONFLICT
        - RATE_LIMIT
        - UPSTREAM
        - TIMEOUT
        - INTERNAL
  responses:
    TooManyRequests:
      description: >-
        Rate limited (`rate_limited`). `details` carries the limit, the window
        and how long until it reopens.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    connectAppKey:
      type: apiKey
      in: header
      name: x-paygent-connect-app-key
      description: >-
        A Connect app key (`pgc_app_…`), identifying the registered third-party
        app. Always presented together with `connectGrant` — the pair is one
        credential, and either half alone is refused. Accepted on the
        `/connect/*` surface only.

````