---
updatedAt: 2025-05-28T20:07:19.000Z
agentTools:
  projectIndex: https://devportal.fintensy.com/llms.txt
---

# Launch a transaction-analysis for a collection of bank-holders grouped together.

POST: /banks/bank-holder-groups/{groupId}/transaction-analysis

# OpenAPI definition

```json
{
  "openapi": "3.0.4",
  "info": {
    "title": "OpenBanking API definitions",
    "description": "An overview of the API definitions used in the OpenBanking application.",
    "contact": {
      "name": "Fintensy",
      "url": "https://www.fintensy.com/"
    },
    "version": "v1"
  },
  "paths": {
    "/banks/bank-holder-groups/{groupId}/transaction-analysis": {
      "post": {
        "tags": [
          "BankHolderGroupAnalysis"
        ],
        "summary": "Launch a transaction-analysis for a collection of bank-holders grouped together.",
        "description": "POST: /banks/bank-holder-groups/{groupId}/transaction-analysis",
        "parameters": [
          {
            "name": "groupId",
            "in": "path",
            "description": "The identifier of the bank-holder group.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "description": "The input model.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OpenBanking.Web.Api.Models.BankHolderGroupAnalysis.AnalyzeInputModel"
              }
            },
            "application/*+json": {
              "schema": {
                "$ref": "#/components/schemas/OpenBanking.Web.Api.Models.BankHolderGroupAnalysis.AnalyzeInputModel"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The entity has been created.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "format": "uuid"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The input model is not valid.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Mozzeno.Web.Api.ErrorModel"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Mozzeno.Web.Api.ErrorInformationModel": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "nullable": true
          },
          "actual_value": {
            "type": "string",
            "nullable": true
          },
          "code": {
            "type": "integer",
            "format": "int32"
          },
          "min_length": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "max_length": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "Mozzeno.Web.Api.ErrorModel": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "nullable": true
          },
          "message": {
            "type": "string",
            "nullable": true
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Mozzeno.Web.Api.ErrorInformationModel"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "OpenBanking.Enums.PersonRole": {
        "enum": [
          0,
          1,
          2,
          3
        ],
        "type": "integer",
        "description": "0 = Unknown, 1 = Primary, 2 = Secondary, 3 = Guarantor",
        "format": "int32"
      },
      "OpenBanking.Web.Api.Models.BankHolderGroupAnalysis.AnalyzeInputModel": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "nullable": true
          },
          "purpose_category": {
            "type": "string",
            "nullable": true
          },
          "bank_holders": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OpenBanking.Web.Api.Models.BankHolderGroupAnalysis.BankHolderInputModel"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "OpenBanking.Web.Api.Models.BankHolderGroupAnalysis.BankHolderInputModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "role": {
            "$ref": "#/components/schemas/OpenBanking.Enums.PersonRole"
          },
          "first_name": {
            "type": "string",
            "nullable": true
          },
          "last_name": {
            "type": "string",
            "nullable": true
          },
          "employer": {
            "type": "string",
            "nullable": true
          },
          "monthly_income_salary": {
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "housing_status": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "marital_status": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "company_type": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "company_name": {
            "type": "string",
            "nullable": true
          },
          "enterprise_number": {
            "type": "string",
            "nullable": true
          },
          "current_job_title": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "monthly_income_others": {
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "monthly_income_rentals": {
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "monthly_housing_costs": {
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "monthly_alimony": {
            "type": "number",
            "format": "double",
            "nullable": true
          }
        },
        "additionalProperties": false
      }
    }
  },
  "servers": [
    {
      "url": "https://api.myproved.eu"
    }
  ]
}
```