Skip to main content
POST
/
connection
/
context
Get connection status details
curl --request POST \
  --url https://sandbox.deck.co/api/v1/connection/context \
  --header 'Content-Type: application/json' \
  --header 'x-deck-client-id: <api-key>' \
  --header 'x-deck-secret: <api-key>' \
  --data '{
  "access_token": "<string>"
}'
{
  "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "provider": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "connection_status": "New",
  "connection_status_timestamp": "2023-11-07T05:31:56Z",
  "connection_status_reason": "New",
  "num_of_entities": 123,
  "entities": [
    {
      "account_number": "<string>"
    }
  ]
}

Authorizations

​
x-deck-client-id
string
header
required

Enter your client id

​
x-deck-secret
string
header
required

Enter your secret

Body

​
access_token
string
required

The access token associated with the Item data is being requested for

Minimum length: 1

Response

OK

​
provider
object
required

The data source associated to this connectiond

​
entities
object[]
required

A list of entities associated with this connection.

​
connection_id
string<uuid>

The Deck Connection ID associated with the access token data being requested

​
connection_status
enum<string>

Represents the current connection health status between the system and the data source, such as Connected or Disconnected.

Available options:
New,
Connecting,
Connected,
Disconnected,
Error
​
connection_status_timestamp
string<date-time>

The UTC timestamp of when the connectivity status was last updated.

​
connection_status_reason
enum<string>

Represents the most recent scraping result for this connection, providing additional context to the connectivity status.

Available options:
New,
Connecting,
CredentialsSent,
InvalidCredentials,
ConnectedCredentials,
SecurityAnswerRequired,
SecurityAnswerInvalid,
SecurityQuestionTimeout,
MfaMethodChoiceRequired,
MfaCodeRequired,
MfaCodeInvalid,
MfaCodeTimeout,
MfaActionRequired,
BlockedByPin,
AccountSelectionRequired,
WaitingForJob,
ExecutingJob,
CompletedJob,
RetryLater,
DataFound,
ConnectedWaitingOnDataExtraction,
NoDataFound,
NoStatement,
Error
​
num_of_entities
integer

Represents the number of accounts.

⌘I