Skip to main content
POST
/
link
/
connect
Connect with credentials
curl --request POST \
  --url https://sandbox.deck.co/api/v1/link/connect \
  --header 'Content-Type: application/json' \
  --data '{
  "link_token": "<string>",
  "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "fields": [
    {
      "field_name": "<string>",
      "field_value": "<string>"
    }
  ],
  "terms_of_use_url": "<string>",
  "privacy_policy_url": "<string>"
}'
{
  "public_token": "<string>",
  "job_guid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Body

​
link_token
string
required

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

Minimum length: 1
​
source_id
string<uuid>
required

Identifier of the data source to connect to.

​
fields
object[]
required

List of values provided for fields specific to the selected source

​
terms_of_use_url
string | null

The accepted terms of use by the end-user

​
privacy_policy_url
string | null

The accepted privacy policy by the end-user

Response

OK

​
public_token
string | null

This token must be exchanged for an access_token. In Update mode for an existing connection, the public_token is not returned: There is no need to go through the process of exchanging a public_token for an access_token and the connection's existing access_token will not change.

​
job_guid
string<uuid> | null

Used to identify a connection in webhooks.

⌘I