---
updatedAt: 2026-05-21T02:59:13.000Z
agentTools:
  projectIndex: https://api.basiq.io/llms.txt
---

# Retrieve Insight Type

Returns the definition of a single supported CDR Insight type identified by `{typeId}`.

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Insights",
    "description": "All included utility endpoints for Basiq partners",
    "version": "3.0.0",
    "termsOfService": "https://docs.basiq.io/en/collections/440849-privacy-terms-and-common-questions",
    "license": {
      "name": "Commercial",
      "url": "https://basiq.io"
    }
  },
  "servers": [
    {
      "url": "https://au-api.basiq.io"
    }
  ],
  "paths": {
    "/insights/types/{typeId}": {
      "get": {
        "tags": [
          "Insights"
        ],
        "summary": "Retrieve Insight Type",
        "operationId": "getInsightType",
        "description": "Returns the definition of a single supported CDR Insight type identified by `{typeId}`.",
        "parameters": [
          {
            "name": "typeId",
            "in": "path",
            "required": true,
            "description": "The Insight type identifier. Must be one of the supported enum values.",
            "schema": {
              "type": "string",
              "enum": [
                "ACCOUNT_VERIFICATION",
                "BALANCE_VERIFICATION",
                "IDENTITY_VERIFICATION",
                "INCOME_VERIFICATION",
                "EXPENSE_RATIO_VERIFICATION"
              ]
            },
            "examples": {
              "accountVerification": {
                "summary": "Account Verification",
                "value": "ACCOUNT_VERIFICATION"
              },
              "balanceVerification": {
                "summary": "Balance Verification",
                "value": "BALANCE_VERIFICATION"
              },
              "identityVerification": {
                "summary": "Identity Verification",
                "value": "IDENTITY_VERIFICATION"
              },
              "incomeVerification": {
                "summary": "Income Verification",
                "value": "INCOME_VERIFICATION"
              },
              "expenseRatioVerification": {
                "summary": "Expense Ratio Verification",
                "value": "EXPENSE_RATIO_VERIFICATION"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully retrieved Insight type definition",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InsightTypeItem"
                },
                "examples": {
                  "accountVerification": {
                    "summary": "Account Verification",
                    "value": {
                      "type": "insightType",
                      "id": "ACCOUNT_VERIFICATION",
                      "supportMultipleUsers": false,
                      "name": "Account Verification",
                      "description": "Verifies whether the provided account number matches any of the user's accounts.",
                      "dataSchema": {
                        "accountNumber": "string",
                        "accountType": "string"
                      }
                    }
                  },
                  "balanceVerification": {
                    "summary": "Balance Verification",
                    "value": {
                      "type": "insightType",
                      "id": "BALANCE_VERIFICATION",
                      "supportMultipleUsers": false,
                      "name": "Balance Verification",
                      "description": "Verifies whether an account balance falls within the specified minimum and/or maximum values.",
                      "dataSchema": {
                        "balance": {
                          "min": "string",
                          "max": "string"
                        }
                      }
                    }
                  },
                  "identityVerification": {
                    "summary": "Identity Verification",
                    "value": {
                      "type": "insightType",
                      "id": "IDENTITY_VERIFICATION",
                      "supportMultipleUsers": false,
                      "name": "Identity Verification",
                      "description": "Verifies one or more identity attributes for a user.",
                      "dataSchema": {
                        "name": "string",
                        "email": "string",
                        "phone": "string",
                        "address": "string"
                      }
                    }
                  },
                  "incomeVerification": {
                    "summary": "Income Verification",
                    "value": {
                      "type": "insightType",
                      "id": "INCOME_VERIFICATION",
                      "supportMultipleUsers": false,
                      "name": "Income Verification",
                      "description": "Verifies user income against provided minimum and/or maximum thresholds.",
                      "dataSchema": {
                        "income": {
                          "min": "string",
                          "max": "string"
                        }
                      }
                    }
                  },
                  "expenseRatioVerification": {
                    "summary": "Expense Ratio Verification",
                    "value": {
                      "type": "insightType",
                      "id": "EXPENSE_RATIO_VERIFICATION",
                      "supportMultipleUsers": true,
                      "name": "Expense Ratio Verification",
                      "description": "Calculates an expense-to-income ratio based on the provided expense value.",
                      "dataSchema": {
                        "expense": "string"
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized – missing or invalid token",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden – insufficient permissions",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Not Found – the specified `typeId` does not match a known Insight type",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "unknownTypeId": {
                    "summary": "Unknown typeId",
                    "value": {
                      "correlationId": "abc123",
                      "data": [
                        {
                          "type": "parameter-not-valid",
                          "title": "Parameter not valid",
                          "detail": "Insight type 'UNKNOWN_TYPE' is not supported.",
                          "source": {
                            "parameter": "typeId"
                          }
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "services_token": []
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "services_token": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    },
    "schemas": {
      "InsightTypeItem": {
        "type": "object",
        "description": "A single supported Insight type entry. The `dataSchema` field describes only the Insight-specific input — it does not represent the full `POST /insights` request body.",
        "required": [
          "type",
          "id",
          "supportMultipleUsers",
          "name",
          "description",
          "dataSchema"
        ],
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "insightType"
            ],
            "description": "Resource type identifier, always `insightType`."
          },
          "id": {
            "type": "string",
            "enum": [
              "ACCOUNT_VERIFICATION",
              "BALANCE_VERIFICATION",
              "IDENTITY_VERIFICATION",
              "INCOME_VERIFICATION",
              "EXPENSE_RATIO_VERIFICATION"
            ],
            "description": "Unique identifier for the Insight type. Maps to the `insightType` values used by existing Insight endpoints: `account`, `balance`, `identity`, `income`, `expense-ratio`."
          },
          "supportMultipleUsers": {
            "type": "boolean",
            "description": "Whether this Insight type supports multiple users in a single request."
          },
          "name": {
            "type": "string",
            "description": "Human-readable name for the Insight type.",
            "example": "Account Verification"
          },
          "description": {
            "type": "string",
            "description": "Description of what the Insight type verifies.",
            "example": "Verifies whether the provided account number matches any of the user's accounts."
          },
          "dataSchema": {
            "type": "object",
            "description": "Describes only the Insight-specific input data accepted by existing Insight endpoints for this type. Does not include transport-level fields such as `users` or `type`.",
            "additionalProperties": true
          }
        }
      },
      "ErrorResponse": {
        "type": "object",
        "required": [
          "type",
          "correlationId",
          "data"
        ],
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "list"
            ],
            "description": "Response type for error responses",
            "example": "list"
          },
          "correlationId": {
            "type": "string",
            "format": "uuid",
            "description": "Unique identifier for tracking this request",
            "example": "0cf1a1fe-de4a-4e01-b81e-60790a1e881b"
          },
          "data": {
            "type": "array",
            "description": "Array containing error details",
            "items": {
              "$ref": "#/components/schemas/ErrorDetail"
            }
          }
        }
      },
      "ErrorDetail": {
        "type": "object",
        "required": [
          "type",
          "code",
          "title",
          "detail"
        ],
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "error"
            ],
            "description": "Type of data object",
            "example": "error"
          },
          "code": {
            "type": "string",
            "description": "Error code identifier",
            "example": "access-denied"
          },
          "title": {
            "type": "string",
            "description": "Human-readable error title",
            "example": "Access denied."
          },
          "detail": {
            "type": "string",
            "description": "Detailed error message",
            "example": "invalid token"
          },
          "source": {
            "oneOf": [
              {
                "type": "object",
                "nullable": true,
                "properties": {
                  "pointer": {
                    "type": "string"
                  },
                  "parameter": {
                    "type": "string"
                  }
                }
              }
            ],
            "description": "Source of the error (optional)",
            "example": null
          }
        }
      }
    }
  }
}
```