Skip to content
This repository was archived by the owner on Jul 24, 2023. It is now read-only.

ConnectionGetResponseResource.md

Latest commit

 

History

History
29 lines (18 loc) · 1.49 KB

ConnectionGetResponseResource.md

File metadata and controls

29 lines (18 loc) · 1.49 KB

BasiqApi.ConnectionGetResponseResource

Properties

Name Type Description Notes
accounts AccountsContainer [optional]
id String A string that uniquely identifies the user connection.
institution ConnectionInstitution
createdDate String Created date of the connection, available only for SERVER_SCOPE.
lastUsed String UTC Date and Time of when the connection was last used, in RFC 3339 format, available only for SERVER_SCOPE. [optional]
links GetConnectionLinks
profile ConnectionProfile [optional]
status String Indicates the connection status, available only for SERVER_SCOPE. Possible values include:
  • pending - the connection is in this status briefly until credentials are verified
  • active - the connection is valid (is working!) and the credentials have been verified (the jobs steps will continue)
  • invalid - the connection is no longer valid and requires the user to update their logon details. Invalid connections cannot refreshed until the password is updated.
[optional]
type String Type, always "connection".

Enum: StatusEnum

  • active (value: "active")

  • pending (value: "pending")

  • invalid (value: "invalid")