Skip to main content
POST
/
link
/
connection
/
status
Get the status of an attempted connection
curl --request POST \
  --url https://sandbox.deck.co/api/v1/link/connection/status \
  --header 'Content-Type: application/json' \
  --data '{
  "link_token": "<string>"
}'
{
  "status": "New",
  "additional_information": "<string>"
}

Body

The link_token, must be provided when calling Link endpoints, for identifying the Link session.

Minimum length: 1

Response

OK

status
enum<string>

The current status of the connection requested

Available options:
New,
Connecting,
Connected,
InvalidCredentials,
Error,
MfaMethodChoice,
MfaQuestion,
MfaQuestionInvalidAnswer,
MfaQuestionNoAnswer,
Captcha,
SecurityQuestion,
AccountSelection
additional_information
string | null

Additional information related to the status

I