Skip to main content

Connections

  • Array [
    • idUUID

    The id for this connection

    appstring

    The app this connection belongs to

    dataholderUUID

    The dataholder id which this connection pulls data from

    userUUID

    The id of the user associated with this connection

    scopesstring[]nullable

    The scopes that have been applied to this connection from the dataholder, will be null if the connection is not in an active, expired or disconnected state

    metricsstring[]nullable

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

    statusConnectionStateEnum

    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]

    connectedAtdate-time
    disconnectedAtdate-time
    BANK_ACCOUNT object
    statusExtractionStateEnum

    Possible values: [SUCCESS, FAILURE]

    referenceIdstring
    lastSuccessdate-time
    lastUpdateddate-time
    BANK_BALANCE object
    statusExtractionStateEnum

    Possible values: [SUCCESS, FAILURE]

    referenceIdstring
    lastSuccessdate-time
    lastUpdateddate-time
    BANK_TRANSACTION object
    statusExtractionStateEnum

    Possible values: [SUCCESS, FAILURE]

    referenceIdstring
    lastSuccessdate-time
    lastUpdateddate-time
    USER_INFO object
    statusExtractionStateEnum

    Possible values: [SUCCESS, FAILURE]

    referenceIdstring
    lastSuccessdate-time
    lastUpdateddate-time
  • ]
    • Connections
    [
      {
        "id": "string",
        "app": "string",
        "dataholder": "string",
        "user": "string",
        "scopes": [
          "string"
        ],
        "metrics": [
          "string"
        ],
        "status": "ACTIVE",
        "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"
          }
        }
      }
    ]