Skip to main content
POST
/
link
/
info
Get client information
curl --request POST \
  --url https://sandbox.deck.co/api/v1/link/info \
  --header 'Content-Type: application/json' \
  --data '{
  "link_token": "<string>"
}'
{
  "name": "<string>",
  "image_url": "<string>",
  "language": "EN",
  "update_mode": {
    "source": {
      "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "logo_url": "<string>",
      "country": "<string>",
      "website": "<string>",
      "fields": [
        {
          "field_number": 123,
          "field_name": "<string>",
          "field_label": "<string>",
          "field_value": "<string>",
          "field_type": "Text"
        }
      ]
    }
  },
  "terms_of_use_url": "<string>",
  "privacy_policy_url": "<string>",
  "mode": "Normal",
  "account_select_mode": "All",
  "allow_document_upload": true,
  "show_step_consent": true,
  "show_step_add_source": true,
  "show_step_select_account": true,
  "show_step_add_account": true
}

Body

​
link_token
string
required

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

Minimum length: 1

Response

OK

​
name
string | null

Client name to display. If the client did not set his name yet, this property will be NULL and a default name should be displayed in that case.

​
image_url
string

Client logo URL to display.

​
language
enum<string>

The language that Link should be displayed in.

Available options:
EN,
ES,
FR,
DE,
IT,
PT,
NL,
PL,
SV,
DA,
NO,
ET,
LT,
LV,
RO
​
update_mode
object

Information about the source, if using Link in Update mode.

​
terms_of_use_url
string | null

Your terms of use to be accepted by the end-user

​
privacy_policy_url
string | null

Your privacy policy to be accepted by the end-user

​
mode
enum<string>

Indicates the mode in which the Link widget should run

Available options:
Normal,
UpdateCredentials,
Refresh,
UpdateAccountSelection
​
account_select_mode
enum<string>

Indicates the mode to select accounts

Available options:
All,
Single,
Multiple
​
allow_document_upload
boolean

Indicates if the Link User should be able to upload documents by himself in Link

​
show_step_consent
boolean

Indicates if link widget should show the consent screen

​
show_step_add_source
boolean

Indicates if link widget should show the add source screen

​
show_step_select_account
boolean

Indicates if link widget should show the account selection screen

​
show_step_add_account
boolean

Indicates if link widget should show the add account screen

⌘I