FinanceKey · Schema

FinanceKey.Entity.ConsentPkg.v_ClientIntegration

FinanceTreasuryArtificial IntelligencePaymentsCash Management

Properties

Name Type Description
createdById integernull The identity of the account that created the initial record.
createdOn string The date and time the record was initially created.
updatedById integernull The identity of the account that last modified the record.
updateOn string The date and time the record was last modified.
closedById integernull The identity of the account that deactivated and closed the record.
closedOn string The date and time the record is to be considered as inactive and closed.
active boolean A flag that shows if the record is currently active. This values is calculated based on the current date and the record closed date.
rowVersion stringnull A unique version stamp of the record.
sessionId stringnull The identity of the session that last modified the record.
clientIntegrationId integer A unique identity number for the enabled integration.
sequence integer The Sequence field in the ClientIntegration table uses an int data type to store a unique integer of up to 11 characters in length that acts as a unique identifier for each row in the table. The Seque
integrationInstituteId integer IntegrationInstituteId is an integer field in the ClientIntegration table which stores an identifier referencing the specific institute a particular client is associated with in relation to integratio
integrationId integer The IntegrationId field in the ClientIntegration table is a unique integer value used to identify the specific record associated with the integration of 2 clients in the system.
consentStateId stringnull The ConsentStateId field in the ClientIntegration table tracks states or actions related to the user's consent or permission status and is stored as a nvarchar with a maximum length of 32 characters.
badgeImage string The BadgeImage field in the ClientIntegration table is a nvarchar data type with a maximum length of 256 characters. This field is used to store the image associated with a client's badge, typically f
reference stringnull The reference by which the client integration is known or identified.
integrationName string IntegrationName is an nvarchar field with a maximum length of 128 characters and is a required field. It is used in the ClientIntegration table to store the unique name for each integration of a clien
integrationCategoryId string The IntegrationCategoryId field in the ClientIntegration table is an nvarchar data type with a maximum length of 64. It contains values that classify the type of integration/connectivity each client r
instituteName string InstituteName is an nvarchar field in the ClientIntegration table that stores the name of an educational institution associated with a particular client integration.
comment stringnull Miscellaneous notes and information for the entry or record.
instituteLogoImage stringnull The InstituteLogoImage field in the ClientIntegration table is an nvarchar field that stores the location information of a logo to be used in representing the institute. The field has a maximum length
expiry stringnull Expiry is a field within the ClientIntegration table that stores data type datetime2. This field serves as a timestamp for when the client's integration documents will expire. As an important element
fullName stringnull The last person that granted the consent for the integration.
photoUrl stringnull The PhotoUrl field in the ClientIntegration table is a data type of nvarchar, used to store a uniform resource locator (URL) that references an image or photograph associated with a client's integrati
nextDue stringnull The date and time the integration will next be processed.
operationalStateBadge stringnull Shows the operational state of the client integration.
lastPolled stringnull LastPolled: A datetime2 field that stores the timestamp of the last successful data retrieval or polling operation for the associated client integration, providing a record of the most recent interact
View JSON Schema on GitHub

JSON Schema

financekey-finance-key-entity-consent-pkg-v-client-integration-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/financekey/json-schema/financekey-finance-key-entity-consent-pkg-v-client-integration-schema.json",
  "title": "FinanceKey.Entity.ConsentPkg.v_ClientIntegration",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/financekey-consents-api-openapi.yml#/components/schemas/FinanceKey.Entity.ConsentPkg.v_ClientIntegration",
  "required": [
    "badgeImage",
    "instituteName",
    "integrationCategoryId",
    "integrationName"
  ],
  "type": "object",
  "properties": {
    "createdById": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The identity of the account that created the initial record.",
      "format": "int32",
      "readOnly": true
    },
    "createdOn": {
      "type": "string",
      "description": "The date and time the record was initially created.",
      "format": "date-time",
      "readOnly": true
    },
    "updatedById": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The identity of the account that last modified the record.",
      "format": "int32",
      "readOnly": true
    },
    "updateOn": {
      "type": "string",
      "description": "The date and time the record was last modified.",
      "format": "date-time",
      "readOnly": true
    },
    "closedById": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The identity of the account that deactivated and closed the record.",
      "format": "int32",
      "readOnly": true
    },
    "closedOn": {
      "type": "string",
      "description": "The date and time the record is to be considered as inactive and closed.",
      "format": "date-time",
      "readOnly": true
    },
    "active": {
      "type": "boolean",
      "description": "A flag that shows if the record is currently active. This values is calculated based on the current date and the record closed date.",
      "readOnly": true
    },
    "rowVersion": {
      "type": [
        "string",
        "null"
      ],
      "description": "A unique version stamp of the record.",
      "format": "byte",
      "readOnly": true
    },
    "sessionId": {
      "type": [
        "string",
        "null"
      ],
      "description": "The identity of the session that last modified the record.",
      "readOnly": true
    },
    "clientIntegrationId": {
      "type": "integer",
      "description": "A unique identity number for the enabled integration.",
      "format": "int32"
    },
    "sequence": {
      "type": "integer",
      "description": "The Sequence field in the ClientIntegration table uses an int data type to store a unique integer of up to 11 characters in length that acts as a unique identifier for each row in the table. The Sequence number also serves as a reference to the order in which data related to a particular ClientIntegration entry was created, meaning higher Sequence numbers occur later than lower Sequence numbers in the ClientIntegration table.",
      "format": "int32"
    },
    "integrationInstituteId": {
      "type": "integer",
      "description": "IntegrationInstituteId is an integer field in the ClientIntegration table which stores an identifier referencing the specific institute a particular client is associated with in relation to integration-related services. This is used to distinguish between multiple integration institutes that the client may be a part of and has no custom meaning.",
      "format": "int32"
    },
    "integrationId": {
      "type": "integer",
      "description": "The IntegrationId field in the ClientIntegration table is a unique integer value used to identify the specific record associated with the integration of 2 clients in the system.",
      "format": "int32"
    },
    "consentStateId": {
      "maxLength": 32,
      "type": [
        "string",
        "null"
      ],
      "description": "The ConsentStateId field in the ClientIntegration table tracks states or actions related to the user's consent or permission status and is stored as a nvarchar with a maximum length of 32 characters."
    },
    "badgeImage": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string",
      "description": "The BadgeImage field in the ClientIntegration table is a nvarchar data type with a maximum length of 256 characters. This field is used to store the image associated with a client's badge, typically for identification or branding purposes. The data in this field can be in any text format, giving flexibility to the type of image that can be stored. This field is essential for the integration of client data and allows for easy retrieval and display of badge images in various applications."
    },
    "reference": {
      "maxLength": 128,
      "type": [
        "string",
        "null"
      ],
      "description": "The reference by which the client integration is known or identified."
    },
    "integrationName": {
      "maxLength": 128,
      "minLength": 1,
      "type": "string",
      "description": "IntegrationName is an nvarchar field with a maximum length of 128 characters and is a required field. It is used in the ClientIntegration table to store the unique name for each integration of a client with the system."
    },
    "integrationCategoryId": {
      "maxLength": 450,
      "minLength": 1,
      "type": "string",
      "description": "The IntegrationCategoryId field in the ClientIntegration table is an nvarchar data type with a maximum length of 64. It contains values that classify the type of integration/connectivity each client requires."
    },
    "instituteName": {
      "minLength": 1,
      "type": "string",
      "description": "InstituteName is an nvarchar field in the ClientIntegration table that stores the name of an educational institution associated with a particular client integration."
    },
    "comment": {
      "type": [
        "string",
        "null"
      ],
      "description": "Miscellaneous notes and information for the entry or record."
    },
    "instituteLogoImage": {
      "maxLength": 600,
      "type": [
        "string",
        "null"
      ],
      "description": "The InstituteLogoImage field in the ClientIntegration table is an nvarchar field that stores the location information of a logo to be used in representing the institute. The field has a maximum length of 611 characters."
    },
    "expiry": {
      "type": [
        "string",
        "null"
      ],
      "description": "Expiry is a field within the ClientIntegration table that stores data type datetime2. This field serves as a timestamp for when the client's integration documents will expire. As an important element in managing data organization, this field ensures that integrated documents are kept up-to-date and accurate. By setting an expiry date, updates or renewals can be scheduled in a timely manner, maintaining the integrity and validity of the client's integration within the system. Users can easily access this field to track the expiration date of documents and take necessary actions to keep the integration current. This field provides a streamlined process for managing and organizing client integrations, ultimately improving the overall functionality and effectiveness of the ClientIntegration table.",
      "format": "date-time"
    },
    "fullName": {
      "type": [
        "string",
        "null"
      ],
      "description": "The last person that granted the consent for the integration."
    },
    "photoUrl": {
      "type": [
        "string",
        "null"
      ],
      "description": "The PhotoUrl field in the ClientIntegration table is a data type of nvarchar, used to store a uniform resource locator (URL) that references an image or photograph associated with a client's integration. This field allows for easy access to a visual representation of the client in the integration process, providing a quick visual reference for identification and tracking purposes. This field may contain a link to a client's avatar, company logo, or any other relevant image that aids in the integration process. The nvarchar data type allows for flexibility in the length of the URL string, ensuring that all types of image sources can be effectively stored in this field."
    },
    "nextDue": {
      "type": [
        "string",
        "null"
      ],
      "description": "The date and time the integration will next be processed.",
      "format": "date-time"
    },
    "operationalStateBadge": {
      "type": [
        "string",
        "null"
      ],
      "description": "Shows the operational state of the client integration."
    },
    "lastPolled": {
      "type": [
        "string",
        "null"
      ],
      "description": "LastPolled: A datetime2 field that stores the timestamp of the last successful data retrieval or polling operation for the associated client integration, providing a record of the most recent interaction with the external system or service.",
      "format": "date-time"
    }
  },
  "additionalProperties": false
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/financekey-finance-key-entity-consent-pkg-v-client-integration"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.