---
updatedAt: 2025-08-27T15:59:35.000Z
agentTools:
  projectIndex: https://docs.moneyhubenterprise.com/v2.5/llms.txt
---

# Retrieve a single auth request

Requires **auth_requests:read** scope.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "Swagger 2.0 docs for the authentication/authorization Moneyhub API",
    "title": "Moneyhub Identity Service",
    "version": "2.0.0"
  },
  "security": [
    {
      "Bearer": []
    }
  ],
  "paths": {
    "/auth-requests/{authRequestId}": {
      "get": {
        "summary": "Retrieve a single auth request",
        "description": "Requires **auth_requests:read** scope.",
        "parameters": [
          {
            "description": "The auth request Id",
            "in": "path",
            "name": "authRequestId",
            "required": true,
            "example": "0b4e6488-6de0-420c-8f56-fee665707d57",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Auth Request Response",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/AuthRequest"
                    },
                    "meta": {
                      "type": "object"
                    }
                  },
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Unsuccessful Response - Forbidden - Invalid scopes",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Unsuccessful Response - Resource Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "tags": [
          "auth-requests"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://identity.moneyhub.co.uk"
    }
  ],
  "components": {
    "securitySchemes": {
      "Bearer": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    },
    "schemas": {
      "AuthRequest": {
        "additionalProperties": false,
        "type": "object",
        "properties": {
          "id": {
            "description": "The id of the auth request",
            "example": "c390a94f-2309-4cdf-8d02-b0c5304d9f66",
            "type": "string",
            "format": "uuid"
          },
          "redirectUri": {
            "description": "The redirect uri sent when creating the auth request",
            "example": "https://api-client/callback",
            "type": "string"
          },
          "createdAt": {
            "description": "The date that the auth request was created.",
            "example": "2018-07-10T12:00:00+00:00",
            "format": "date-time",
            "type": "string"
          },
          "bankId": {
            "description": "The id of the bank",
            "example": "1ffe704d39629a929c8e293880fb449a",
            "type": "string"
          },
          "userId": {
            "description": "The id of the user",
            "example": "5f4e26b2f05339b101e7afe8",
            "type": "string",
            "minLength": 24,
            "maxLength": 24
          },
          "scope": {
            "description": "The scope sent when creating the auth request",
            "example": "openid payment id:1ffe704d39629a929c8e293880fb449a",
            "type": "string"
          },
          "connectionId": {
            "description": "Id of the connection",
            "example": "1ffe704d39629a929c8e293880fb449a:48315090-b022-4716-8c08-5ba176f8fa5a",
            "type": "string"
          },
          "paymentId": {
            "description": "Id of the payment when the auth request had the payment scope",
            "example": "950308a4-7dfe-4ac9-9df5-3957dfe056ac",
            "type": "string",
            "format": "uuid"
          },
          "syncId": {
            "description": "Id of the initial sync, can be used to check status of sync",
            "example": "f0cfeea9-4388-4a19-8e8a-b53a12ebabb8",
            "type": "string"
          },
          "status": {
            "description": "The status of the auth request",
            "example": "complete",
            "type": "string",
            "enum": [
              "complete",
              "pending",
              "error",
              "deleted"
            ]
          }
        },
        "required": [
          "id",
          "bankId",
          "createdAt",
          "status",
          "scope"
        ]
      },
      "Error": {
        "additionalProperties": false,
        "properties": {
          "code": {
            "description": "The error code",
            "type": "string"
          },
          "message": {
            "description": "The error message",
            "type": "string"
          },
          "correlationId": {
            "description": "Id that identifies the request and can be used to ask for more details related to the error",
            "type": "string"
          }
        },
        "required": [
          "code"
        ],
        "type": "object"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```