Skip to main content

Connections

  • Array [
    • idstring<UUID>

    The id for this connection

    appstring

    The app this connection belongs to

    dataholderstring<UUID>

    The dataholder id which this connection pulls data from

    userstring<UUID>required

    The id of the user associated with this connection

    scopesstring[]nullable

    The scopes that have been applied to this connection

    metricsstring[]nullable

    The metrics associated with this connection, this will be null if it is all metrics

    statusConnectionStateEnumdeprecated

    Possible values: [ACTIVE, EXPIRED, DISCONNECTED, INITIATED]

    connectionState object

    The connection state represents a the current status of the connection including timestamps of things that have occurred

    statusConnectionStateEnum

    Possible values: [ACTIVE, EXPIRED, DISCONNECTED, INITIATED]

    connectedAtstring<date-time>
    disconnectedAtstring<date-time>
    BANK_ACCOUNT object
    statusExtractionStateEnum

    Possible values: [SUCCESS, FAILURE]

    referenceIdstring
    lastSuccessstring<date-time>
    lastUpdatedstring<date-time>
    BANK_BALANCE object
    statusExtractionStateEnum

    Possible values: [SUCCESS, FAILURE]

    referenceIdstring
    lastSuccessstring<date-time>
    lastUpdatedstring<date-time>
    BANK_TRANSACTION object
    statusExtractionStateEnum

    Possible values: [SUCCESS, FAILURE]

    referenceIdstring
    lastSuccessstring<date-time>
    lastUpdatedstring<date-time>
    USER_INFO object
    statusExtractionStateEnum

    Possible values: [SUCCESS, FAILURE]

    referenceIdstring
    lastSuccessstring<date-time>
    lastUpdatedstring<date-time>
  • ]
    • Connections
    [
      {
        "id": "string",
        "app": "string",
        "dataholder": "string",
        "user": "string",
        "scopes": [
          "string"
        ],
        "metrics": [
          "string"
        ],
        "connectionState": {
          "status": "ACTIVE",
          "connectedAt": "2024-07-29T15:51:28.071Z",
          "disconnectedAt": "2024-07-29T15:51:28.071Z",
          "BANK_ACCOUNT": {
            "status": "SUCCESS",
            "referenceId": "string",
            "lastSuccess": "2024-07-29T15:51:28.071Z",
            "lastUpdated": "2024-07-29T15:51:28.071Z"
          },
          "BANK_BALANCE": {
            "status": "SUCCESS",
            "referenceId": "string",
            "lastSuccess": "2024-07-29T15:51:28.071Z",
            "lastUpdated": "2024-07-29T15:51:28.071Z"
          },
          "BANK_TRANSACTION": {
            "status": "SUCCESS",
            "referenceId": "string",
            "lastSuccess": "2024-07-29T15:51:28.071Z",
            "lastUpdated": "2024-07-29T15:51:28.071Z"
          },
          "USER_INFO": {
            "status": "SUCCESS",
            "referenceId": "string",
            "lastSuccess": "2024-07-29T15:51:28.071Z",
            "lastUpdated": "2024-07-29T15:51:28.071Z"
          }
        }
      }
    ]