Create Link Session

This endpoint is to be called by your back end, to establish a new link session for creating a link to your end user's institution.

URL

POST

/link-session

Request

curl --request POST \
  --url 'https://api.moneykit.com/link-session' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'X-Client-Id: SOME_STRING_VALUE' \
  --header 'X-Client-Secret: SOME_STRING_VALUE' \
  --header 'X-MoneyKit-User-Token: SOME_STRING_VALUE' \
  --header 'Content-Type: application/json' \
  --data '  {
    "settings": "SOME_STRING_VALUE",
    "customer_user": "SOME_STRING_VALUE",
    "existing_link_id": "SOME_STRING_VALUE",
    "institution_id": "SOME_STRING_VALUE",
    "allowed_institutions": "SOME_STRING_VALUE",
    "blocked_institutions": "SOME_STRING_VALUE",
    "redirect_uri": "SOME_STRING_VALUE",
    "webhook": "SOME_STRING_VALUE",
    "link_tags": "SOME_STRING_VALUE",
    "connect_features": "SOME_STRING_VALUE",
    "custom_sandbox_data": "SOME_STRING_VALUE"
  }'

fetch("https://api.moneykit.com/link-session", {
  "method": "POST",
  "headers": {
    "Authorization": "Bearer REPLACE_BEARER_TOKEN",
    "Content-Type": "application/json",
    "X-Client-Id": "SOME_STRING_VALUE",
    "X-Client-Secret": "SOME_STRING_VALUE",
    "X-MoneyKit-User-Token": "SOME_STRING_VALUE"
  },
  "body": "{\n  \"settings\": \"SOME_STRING_VALUE\",\n  \"customer_user\": \"SOME_STRING_VALUE\",\n  \"existing_link_id\": \"SOME_STRING_VALUE\",\n  \"institution_id\": \"SOME_STRING_VALUE\",\n  \"allowed_institutions\": \"SOME_STRING_VALUE\",\n  \"blocked_institutions\": \"SOME_STRING_VALUE\",\n  \"redirect_uri\": \"SOME_STRING_VALUE\",\n  \"webhook\": \"SOME_STRING_VALUE\",\n  \"link_tags\": \"SOME_STRING_VALUE\",\n  \"connect_features\": \"SOME_STRING_VALUE\",\n  \"custom_sandbox_data\": \"SOME_STRING_VALUE\"\n}"
})
  .then(response => response.json())
  .then(data => console.log(data));

import requests

url = "https://api.moneykit.com/link-session"
headers = {
  'Authorization': 'Bearer REPLACE_BEARER_TOKEN',
  'Content-Type': 'application/json',
  'X-Client-Id': 'SOME_STRING_VALUE',
  'X-Client-Secret': 'SOME_STRING_VALUE',
  'X-MoneyKit-User-Token': 'SOME_STRING_VALUE'
}
data = {
  'settings': 'SOME_STRING_VALUE',
  'customer_user': 'SOME_STRING_VALUE',
  'existing_link_id': 'SOME_STRING_VALUE',
  'institution_id': 'SOME_STRING_VALUE',
  'allowed_institutions': 'SOME_STRING_VALUE',
  'blocked_institutions': 'SOME_STRING_VALUE',
  'redirect_uri': 'SOME_STRING_VALUE',
  'webhook': 'SOME_STRING_VALUE',
  'link_tags': 'SOME_STRING_VALUE',
  'connect_features': 'SOME_STRING_VALUE',
  'custom_sandbox_data': 'SOME_STRING_VALUE'
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

package main

import (
	"fmt"
	"net/http"
	"strings"
)

func main() {
	payload := strings.NewReader(`{
  "settings": "SOME_STRING_VALUE",
  "customer_user": "SOME_STRING_VALUE",
  "existing_link_id": "SOME_STRING_VALUE",
  "institution_id": "SOME_STRING_VALUE",
  "allowed_institutions": "SOME_STRING_VALUE",
  "blocked_institutions": "SOME_STRING_VALUE",
  "redirect_uri": "SOME_STRING_VALUE",
  "webhook": "SOME_STRING_VALUE",
  "link_tags": "SOME_STRING_VALUE",
  "connect_features": "SOME_STRING_VALUE",
  "custom_sandbox_data": "SOME_STRING_VALUE"
}`)

	req, _ := http.NewRequest("POST", "https://api.moneykit.com/link-session", payload)
	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")
	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("X-Client-Id", "SOME_STRING_VALUE")
	req.Header.Add("X-Client-Secret", "SOME_STRING_VALUE")
	req.Header.Add("X-MoneyKit-User-Token", "SOME_STRING_VALUE")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	fmt.Println(res)
}

require 'net/http'
require 'json'

uri = URI('https://api.moneykit.com/link-session')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer REPLACE_BEARER_TOKEN'
request['Content-Type'] = 'application/json'
request['X-Client-Id'] = 'SOME_STRING_VALUE'
request['X-Client-Secret'] = 'SOME_STRING_VALUE'
request['X-MoneyKit-User-Token'] = 'SOME_STRING_VALUE'
request.body = '{
  "settings": "SOME_STRING_VALUE",
  "customer_user": "SOME_STRING_VALUE",
  "existing_link_id": "SOME_STRING_VALUE",
  "institution_id": "SOME_STRING_VALUE",
  "allowed_institutions": "SOME_STRING_VALUE",
  "blocked_institutions": "SOME_STRING_VALUE",
  "redirect_uri": "SOME_STRING_VALUE",
  "webhook": "SOME_STRING_VALUE",
  "link_tags": "SOME_STRING_VALUE",
  "connect_features": "SOME_STRING_VALUE",
  "custom_sandbox_data": "SOME_STRING_VALUE"
}'

response = http.request(request)
puts response.body

import Foundation

let url = URL(string: "https://api.moneykit.com/link-session")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.setValue("Bearer REPLACE_BEARER_TOKEN", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.setValue("SOME_STRING_VALUE", forHTTPHeaderField: "X-Client-Id")
request.setValue("SOME_STRING_VALUE", forHTTPHeaderField: "X-Client-Secret")
request.setValue("SOME_STRING_VALUE", forHTTPHeaderField: "X-MoneyKit-User-Token")

let jsonData = "{
  "settings": "SOME_STRING_VALUE",
  "customer_user": "SOME_STRING_VALUE",
  "existing_link_id": "SOME_STRING_VALUE",
  "institution_id": "SOME_STRING_VALUE",
  "allowed_institutions": "SOME_STRING_VALUE",
  "blocked_institutions": "SOME_STRING_VALUE",
  "redirect_uri": "SOME_STRING_VALUE",
  "webhook": "SOME_STRING_VALUE",
  "link_tags": "SOME_STRING_VALUE",
  "connect_features": "SOME_STRING_VALUE",
  "custom_sandbox_data": "SOME_STRING_VALUE"
}".data(using: .utf8)!
request.httpBody = jsonData

let task = URLSession.shared.dataTask(with: request) { data, response, error in
    guard let data = data else { return }
    print(String(data: data, encoding: .utf8)!)
}
task.resume()

Response

{
  "link_session_token": "c7318ff7-257c-490e-8242-03a815b223b7"
}

{
  "error_code": "api_error.auth.expired_access_token",
  "error_message": "Access token expired",
  "documentation_url": string
}

{
  "error_code": "link_session_error.forbidden_config",
  "error_message": "Forbidden use of a Connect feature",
  "documentation_url": string
}

allowed_institutions

: array

A list of IDs for institutions you want to enable linking to. Providing this will hide all other institutions during institution selection. Note that if it is not possible to show any institutions (due to other restrictions such as provider, product, or country) then creating the link session will fail.

example: ["chase", "bofa"]

blocked_institutions

: array

A list of IDs for institutions you want to disable linking to. Providing this will hide these institutions during institution selection. Note that if it is not possible to show any institutions (due to other restrictions such as provider, product, or country) then creating the link session will fail.

example: ["chase", "bofa"]

connect_features

: object

Enables optional testing and UI features.

default: {"issue_reporter":false,"enable_money_id":false,"duplicate_institution_warning":false,"duplicate_institution_rejected":false,"connect_manually":false,"permit_only_one_account":false,"permit_only_depository_accounts":false,"bug_reporter":false,"enable_device_verification":false,"provider_sandbox_institutions":false,"simulate_provider_error":false}

custom_sandbox_data

: object

If provided, will allow custom static data to be returned on Credentials Bank in Sandbox mode, using the user user_custom.

customer_user

: object

required

Details about your end user. These details are used to improve conversion, streamline the linking flow, and provide enhanced debugging and improved privacy controls for your end user.

existing_link_id

: string

Supply the existing link_id if you are asking the user to reconnect or modify this link.

When reconnecting, if new accounts are discovered they will be presented to the user so permission to access them can be granted (or denied). Access to previously permitted accounts is not revokable at this point.

If necessary, MoneyKit may attempt to reconnect the account using a different provider than the link was originally connected through. The change in provider is generally seamless. MoneyKit normalizes incoming data to minimize provider-specific differences, and we deduplicate new transactions, so data continuity is generally assured; however, small discrepancies can still occur.

A reconnection cannot change the institution, the customer_user.id, or the country for an existing link. These parameters will be silently ignored if existing_link_id is supplied.

New products can be added to an existing link. The user will be asked for permission for any added products. Existing product settings, however, cannot be changed and will be silently ignored.

The webhook for an existing link can be changed, and the existing webhook will be removed if the webhook parameter is omitted, so you should supply the webhook URL if you want to receive webhook events for the reconnected link.

Similarly, a reconnected link will be assigned whatever link_tags are supplied, and existing tags will be removed if link_tags is omitted, so you should supply the link_tags you want the link to have, if any.

example: mk_eqkWN34UEoa2NxyALG8pcV

institution_id

: string

The ID of the institution you want to link to. Providing this will skip the institution selection step. This field is ignored if existing_link_id is provided.

example: chase

link_tags

: array

You can supply one or more arbitrary strings as tags to describe this link. Tags must be under 100 characters in length, and begin with an alphanumeric character.

example: user_type:admin

redirect_uri

: string (uri)

required

For Oauth linking, a URI indicating the destination, in your application, where the user should be sent after authenticating with the institution. The redirect_uri should not contain any query parameters, and its protocol://host[:port]/ must be listed in your dashboard settings.

format:

uri

min length:

example: https://yourdomain.com/oauth.html

settings

: object

If provided, these settings will override your default settings for this session.

webhook

: string (uri)

The destination URL to which any webhooks should be sent.

example: https://yourdomain.com/moneykit_webhook

{"params":[{"name":"settings","url_hash":"#settings","description":"If provided, these settings will override your default settings for this session."},{"name":"settings-providers","url_hash":"#settings-providers","description":"If provided, restricts the available institutions to those supported\n by **any** of these providers."},{"name":"settings-products","url_hash":"#settings-products","description":"If provided, configures what institutions are available and how data should be fetched."},{"name":"settings-products-account_numbers-required","url_hash":"#settings-products-account_numbers-required","description":"If true, only institutions supporting this product will be available."},{"name":"settings-products-account_numbers-require_permission","url_hash":"#settings-products-account_numbers-require_permission","description":"This flag matters only if `required` is false. For non-required products,\n the product permission is normally presented to the user as optional (granted by default, but the user may\n opt out). If this flag is true, however, the product permission will be presented in the UI as non-optional:\n the user's only choice is to grant the permission or to cancel the link.\n \n Note that this field is ignored if `required` is true. Permission is always mandatory for required products."},{"name":"settings-products-account_numbers-prefetch","url_hash":"#settings-products-account_numbers-prefetch","description":"If true, the data will be available as soon as possible after linking, even if `required` is false. If false, the data will be available after the first manual data refresh."},{"name":"settings-products-account_numbers-reason","url_hash":"#settings-products-account_numbers-reason","description":"A **brief** description of the reason your app wants this data.\n This description will follow the words \"...data is used to\", and will be displayed\n to the user when permission is requested. You should provide this field if your\n app does not request this product by default, or if you want to show a particular\n reason for requesting the product during this link session."},{"name":"settings-products-identity-required","url_hash":"#settings-products-identity-required","description":"If true, only institutions supporting this product will be available."},{"name":"settings-products-identity-require_permission","url_hash":"#settings-products-identity-require_permission","description":"This flag matters only if `required` is false. For non-required products,\n the product permission is normally presented to the user as optional (granted by default, but the user may\n opt out). If this flag is true, however, the product permission will be presented in the UI as non-optional:\n the user's only choice is to grant the permission or to cancel the link.\n \n Note that this field is ignored if `required` is true. Permission is always mandatory for required products."},{"name":"settings-products-identity-prefetch","url_hash":"#settings-products-identity-prefetch","description":"If true, the data will be available as soon as possible after linking, even if `required` is false. If false, the data will be available after the first manual data refresh."},{"name":"settings-products-identity-reason","url_hash":"#settings-products-identity-reason","description":"A **brief** description of the reason your app wants this data.\n This description will follow the words \"...data is used to\", and will be displayed\n to the user when permission is requested. You should provide this field if your\n app does not request this product by default, or if you want to show a particular\n reason for requesting the product during this link session."},{"name":"settings-products-transactions-required","url_hash":"#settings-products-transactions-required","description":"If true, only institutions supporting this product will be available."},{"name":"settings-products-transactions-require_permission","url_hash":"#settings-products-transactions-require_permission","description":"This flag matters only if `required` is false. For non-required products,\n the product permission is normally presented to the user as optional (granted by default, but the user may\n opt out). If this flag is true, however, the product permission will be presented in the UI as non-optional:\n the user's only choice is to grant the permission or to cancel the link.\n \n Note that this field is ignored if `required` is true. Permission is always mandatory for required products."},{"name":"settings-products-transactions-prefetch","url_hash":"#settings-products-transactions-prefetch","description":"If true, the data will be available as soon as possible after linking, even if `required` is false. If false, the data will be available after the first manual data refresh."},{"name":"settings-products-transactions-reason","url_hash":"#settings-products-transactions-reason","description":"A **brief** description of the reason your app wants this data.\n This description will follow the words \"...data is used to\", and will be displayed\n to the user when permission is requested. You should provide this field if your\n app does not request this product by default, or if you want to show a particular\n reason for requesting the product during this link session."},{"name":"settings-products-investments-required","url_hash":"#settings-products-investments-required","description":"If true, only institutions supporting this product will be available."},{"name":"settings-products-investments-require_permission","url_hash":"#settings-products-investments-require_permission","description":"This flag matters only if `required` is false. For non-required products,\n the product permission is normally presented to the user as optional (granted by default, but the user may\n opt out). If this flag is true, however, the product permission will be presented in the UI as non-optional:\n the user's only choice is to grant the permission or to cancel the link.\n \n Note that this field is ignored if `required` is true. Permission is always mandatory for required products."},{"name":"settings-products-investments-prefetch","url_hash":"#settings-products-investments-prefetch","description":"If true, the data will be available as soon as possible after linking, even if `required` is false. If false, the data will be available after the first manual data refresh."},{"name":"settings-products-investments-reason","url_hash":"#settings-products-investments-reason","description":"A **brief** description of the reason your app wants this data.\n This description will follow the words \"...data is used to\", and will be displayed\n to the user when permission is requested. You should provide this field if your\n app does not request this product by default, or if you want to show a particular\n reason for requesting the product during this link session."},{"name":"settings-countries","url_hash":"#settings-countries","description":"Restricts the available institutions to those in **any** of these countries. If more than\n one country is listed, the institution panel shown to the user will be prioritied by the order given. If\n omitted, your app's primary country is used (the default is US)."},{"name":"customer_user","url_hash":"#customer_user","description":"Details about your end user. These details are used to improve conversion, streamline\n the linking flow, and provide enhanced debugging and improved privacy controls for your end user."},{"name":"customer_user-id","url_hash":"#customer_user-id","description":"Your own unique ID for this user. Typically this will be a UUID or primary key\n from your application."},{"name":"customer_user-email","url_hash":"#customer_user-email","description":"The user's email address. This field is optional, but either email or phone must be provided\n to enable improved link conversion."},{"name":"customer_user-email-address","url_hash":"#customer_user-email-address","description":"The user's email address."},{"name":"customer_user-email-customer_verified_at","url_hash":"#customer_user-email-customer_verified_at","description":"Optional timestamp that marks when you last verified this email (such as when the user most\n recently clicked a verification url sent to this address).\n Only include this field if you verified the address. You may supply zeros if the time (but not the date)\n is unknown."},{"name":"customer_user-phone","url_hash":"#customer_user-phone","description":"The user's mobile phone number. This field is optional, but either email or phone must be\n provided to enable improved link conversion."},{"name":"customer_user-phone-number","url_hash":"#customer_user-phone-number","description":"The user's phone number, preferably in E164 format, including the country code."},{"name":"customer_user-phone-country","url_hash":"#customer_user-phone-country","description":"Optional two-letter country code, which can be supplied when the phone number does not start\n with the E164 numeric country code."},{"name":"customer_user-phone-customer_verified_at","url_hash":"#customer_user-phone-customer_verified_at","description":"Optional timestamp that marks when you last verified this number (such as when the user most\n recently returned a verification code sent via SMS to this number).\n Only include this field if you verified the number. You may supply zeros if the time (but not the date)\n is unknown."},{"name":"existing_link_id","url_hash":"#existing_link_id","description":"Supply the existing `link_id` if you are asking the user to reconnect or modify this link.\n When reconnecting, if new accounts are discovered they will be presented to the user so permission\n to access them can be granted (or denied). Access to previously permitted accounts is not revokable\n at this point.\n If necessary, MoneyKit may attempt to reconnect the account using a different provider than the link\n was originally connected through. The change in provider is generally seamless. MoneyKit normalizes\n incoming data to minimize provider-specific differences, and we deduplicate new transactions, so\n data continuity is generally assured; however, small discrepancies can still occur.\n A reconnection cannot change the institution, the customer_user.id, or the country for an\n existing link. These parameters will be silently ignored if `existing_link_id` is supplied.\n New products can be added to an existing link. The user will be asked for permission for any added\n products. Existing product settings, however, cannot be changed and will be silently ignored.\n The `webhook` for an existing link **can** be changed, and the existing webhook will be **removed** if\n the `webhook` parameter is omitted, so you should supply the `webhook` URL if you want to receive\n webhook events for the reconnected link.\n Similarly, a reconnected link will be assigned whatever `link_tags` are supplied, and existing tags will\n be removed if `link_tags` is omitted, so you should supply the `link_tags` you want the link to have, if any.\n "},{"name":"institution_id","url_hash":"#institution_id","description":"The ID of the institution you want to link to. Providing this will skip the institution\n selection step. This field is ignored if `existing_link_id` is provided."},{"name":"allowed_institutions","url_hash":"#allowed_institutions","description":"A list of IDs for institutions you want to enable linking to. Providing this will hide all\n other institutions during institution selection. Note that if it is not possible to show any institutions\n (due to other restrictions such as provider, product, or country) then creating the link session will fail."},{"name":"blocked_institutions","url_hash":"#blocked_institutions","description":"A list of IDs for institutions you want to disable linking to. Providing this will hide these\n institutions during institution selection. Note that if it is not possible to show any institutions\n (due to other restrictions such as provider, product, or country) then creating the link session will fail."},{"name":"redirect_uri","url_hash":"#redirect_uri","description":"For Oauth linking, a URI indicating the destination, in your application, where the user should\n be sent after authenticating with the institution. The `redirect_uri` should not contain any query parameters,\n and its protocol://host[:port]/ must be listed in\n your <a href=https://dashboard.moneykit.com/settings/company/oauth>dashboard settings</a>."},{"name":"webhook","url_hash":"#webhook","description":"The destination URL to which any webhooks should be sent."},{"name":"link_tags","url_hash":"#link_tags","description":"You can supply one or more arbitrary strings as tags to describe this link. Tags must be under 100 characters in length, and begin with an alphanumeric character."},{"name":"connect_features","url_hash":"#connect_features","description":"Enables optional testing and UI features."},{"name":"connect_features-issue_reporter","url_hash":"#connect_features-issue_reporter","description":"If enabled, the user can report linking issues directly to MoneyKit via 'Report Issue' button."},{"name":"connect_features-enable_money_id","url_hash":"#connect_features-enable_money_id","description":"Money ID is retired. This flag is accepted for backward compatibility but ignored; it has no effect."},{"name":"connect_features-duplicate_institution_warning","url_hash":"#connect_features-duplicate_institution_warning","description":"If enabled, the user will see a warning when trying to connect to an institution for which\n they already have a connected link."},{"name":"connect_features-duplicate_institution_rejected","url_hash":"#connect_features-duplicate_institution_rejected","description":"If enabled, all institutions for which the user has a connected link will be hidden, so the user\n will be unable to make another link to an institution to which they are already linked."},{"name":"connect_features-connect_manually","url_hash":"#connect_features-connect_manually","description":"If enabled, the user can click a button in the MoneyKit Connect SDK to connect manually if the institution they are looking for doesn't exist in our catalog."},{"name":"connect_features-permit_only_one_account","url_hash":"#connect_features-permit_only_one_account","description":"If enabled, the user is allowed to grant permission only for one account."},{"name":"connect_features-permit_only_depository_accounts","url_hash":"#connect_features-permit_only_depository_accounts","description":"If enabled, the user is allowed to grant permission only for depository accounts.\n If there are no depository accounts, the linking process will fail."},{"name":"custom_sandbox_data","url_hash":"#custom_sandbox_data","description":"If provided, will allow custom static data to be returned on Credentials Bank in Sandbox mode, using the user `user_custom`."},{"name":"custom_sandbox_data-accounts","url_hash":"#custom_sandbox_data-accounts","description":"An array of static accounts to be returned from Sandbox via `user_custom`."},{"name":"custom_sandbox_data-accounts-account_type","url_hash":"#custom_sandbox_data-accounts-account_type","description":"Account type applied to the sandbox account. See <a href=/pages/account_types>Account Types</a> for a full listing."},{"name":"custom_sandbox_data-accounts-name","url_hash":"#custom_sandbox_data-accounts-name","description":"Account name used for the sandbox account."},{"name":"custom_sandbox_data-accounts-account_number","url_hash":"#custom_sandbox_data-accounts-account_number","description":"Account number used for the sandbox account."},{"name":"custom_sandbox_data-accounts-routing_number","url_hash":"#custom_sandbox_data-accounts-routing_number","description":"Routing number used for the sandbox account (if applicable). Must follow the standard ABA routing transit number format with a valid check digit, but does not need to be a real bank's routing number."},{"name":"custom_sandbox_data-owners","url_hash":"#custom_sandbox_data-owners","description":"An array of owners to attach to the identity response of every account on `user_custom`. Owners will otherwise be randomly generated."},{"name":"X-Client-Id","url_hash":"#X-Client-Id","description":"Your client ID."},{"name":"X-Client-Secret","url_hash":"#X-Client-Secret","description":"Your client secret"},{"name":"X-MoneyKit-User-Token","url_hash":"#X-MoneyKit-User-Token","description":"Clerk JWT required when creating a link session for a Playground app."}]}

X-Client-Id

: string

Your client ID.

example: live_dcc75c42eb6122127356

X-Client-Secret

: string

Your client secret

example: vzPznCv3kT7fHsAr6y3jk38d

X-MoneyKit-User-Token

: string

Clerk JWT required when creating a link session for a Playground app.

Responses

201

Successful Response

link_session_token

: string

A unique token identifying this link session.

example: c7318ff7-257c-490e-8242-03a815b223b7

403

Forbidden session configuration.

error_code

: string

default: "link_session_error.forbidden_config"

error_message

: string

Error message

example: Forbidden use of a Connect feature

documentation_url

: string

Request

curl --request POST \
  --url 'https://api.moneykit.com/link-session' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'X-Client-Id: SOME_STRING_VALUE' \
  --header 'X-Client-Secret: SOME_STRING_VALUE' \
  --header 'X-MoneyKit-User-Token: SOME_STRING_VALUE' \
  --header 'Content-Type: application/json' \
  --data '  {
    "settings": "SOME_STRING_VALUE",
    "customer_user": "SOME_STRING_VALUE",
    "existing_link_id": "SOME_STRING_VALUE",
    "institution_id": "SOME_STRING_VALUE",
    "allowed_institutions": "SOME_STRING_VALUE",
    "blocked_institutions": "SOME_STRING_VALUE",
    "redirect_uri": "SOME_STRING_VALUE",
    "webhook": "SOME_STRING_VALUE",
    "link_tags": "SOME_STRING_VALUE",
    "connect_features": "SOME_STRING_VALUE",
    "custom_sandbox_data": "SOME_STRING_VALUE"
  }'

fetch("https://api.moneykit.com/link-session", {
  "method": "POST",
  "headers": {
    "Authorization": "Bearer REPLACE_BEARER_TOKEN",
    "Content-Type": "application/json",
    "X-Client-Id": "SOME_STRING_VALUE",
    "X-Client-Secret": "SOME_STRING_VALUE",
    "X-MoneyKit-User-Token": "SOME_STRING_VALUE"
  },
  "body": "{\n  \"settings\": \"SOME_STRING_VALUE\",\n  \"customer_user\": \"SOME_STRING_VALUE\",\n  \"existing_link_id\": \"SOME_STRING_VALUE\",\n  \"institution_id\": \"SOME_STRING_VALUE\",\n  \"allowed_institutions\": \"SOME_STRING_VALUE\",\n  \"blocked_institutions\": \"SOME_STRING_VALUE\",\n  \"redirect_uri\": \"SOME_STRING_VALUE\",\n  \"webhook\": \"SOME_STRING_VALUE\",\n  \"link_tags\": \"SOME_STRING_VALUE\",\n  \"connect_features\": \"SOME_STRING_VALUE\",\n  \"custom_sandbox_data\": \"SOME_STRING_VALUE\"\n}"
})
  .then(response => response.json())
  .then(data => console.log(data));

import requests

url = "https://api.moneykit.com/link-session"
headers = {
  'Authorization': 'Bearer REPLACE_BEARER_TOKEN',
  'Content-Type': 'application/json',
  'X-Client-Id': 'SOME_STRING_VALUE',
  'X-Client-Secret': 'SOME_STRING_VALUE',
  'X-MoneyKit-User-Token': 'SOME_STRING_VALUE'
}
data = {
  'settings': 'SOME_STRING_VALUE',
  'customer_user': 'SOME_STRING_VALUE',
  'existing_link_id': 'SOME_STRING_VALUE',
  'institution_id': 'SOME_STRING_VALUE',
  'allowed_institutions': 'SOME_STRING_VALUE',
  'blocked_institutions': 'SOME_STRING_VALUE',
  'redirect_uri': 'SOME_STRING_VALUE',
  'webhook': 'SOME_STRING_VALUE',
  'link_tags': 'SOME_STRING_VALUE',
  'connect_features': 'SOME_STRING_VALUE',
  'custom_sandbox_data': 'SOME_STRING_VALUE'
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

package main

import (
	"fmt"
	"net/http"
	"strings"
)

func main() {
	payload := strings.NewReader(`{
  "settings": "SOME_STRING_VALUE",
  "customer_user": "SOME_STRING_VALUE",
  "existing_link_id": "SOME_STRING_VALUE",
  "institution_id": "SOME_STRING_VALUE",
  "allowed_institutions": "SOME_STRING_VALUE",
  "blocked_institutions": "SOME_STRING_VALUE",
  "redirect_uri": "SOME_STRING_VALUE",
  "webhook": "SOME_STRING_VALUE",
  "link_tags": "SOME_STRING_VALUE",
  "connect_features": "SOME_STRING_VALUE",
  "custom_sandbox_data": "SOME_STRING_VALUE"
}`)

	req, _ := http.NewRequest("POST", "https://api.moneykit.com/link-session", payload)
	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")
	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("X-Client-Id", "SOME_STRING_VALUE")
	req.Header.Add("X-Client-Secret", "SOME_STRING_VALUE")
	req.Header.Add("X-MoneyKit-User-Token", "SOME_STRING_VALUE")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	fmt.Println(res)
}

require 'net/http'
require 'json'

uri = URI('https://api.moneykit.com/link-session')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer REPLACE_BEARER_TOKEN'
request['Content-Type'] = 'application/json'
request['X-Client-Id'] = 'SOME_STRING_VALUE'
request['X-Client-Secret'] = 'SOME_STRING_VALUE'
request['X-MoneyKit-User-Token'] = 'SOME_STRING_VALUE'
request.body = '{
  "settings": "SOME_STRING_VALUE",
  "customer_user": "SOME_STRING_VALUE",
  "existing_link_id": "SOME_STRING_VALUE",
  "institution_id": "SOME_STRING_VALUE",
  "allowed_institutions": "SOME_STRING_VALUE",
  "blocked_institutions": "SOME_STRING_VALUE",
  "redirect_uri": "SOME_STRING_VALUE",
  "webhook": "SOME_STRING_VALUE",
  "link_tags": "SOME_STRING_VALUE",
  "connect_features": "SOME_STRING_VALUE",
  "custom_sandbox_data": "SOME_STRING_VALUE"
}'

response = http.request(request)
puts response.body

import Foundation

let url = URL(string: "https://api.moneykit.com/link-session")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.setValue("Bearer REPLACE_BEARER_TOKEN", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.setValue("SOME_STRING_VALUE", forHTTPHeaderField: "X-Client-Id")
request.setValue("SOME_STRING_VALUE", forHTTPHeaderField: "X-Client-Secret")
request.setValue("SOME_STRING_VALUE", forHTTPHeaderField: "X-MoneyKit-User-Token")

let jsonData = "{
  "settings": "SOME_STRING_VALUE",
  "customer_user": "SOME_STRING_VALUE",
  "existing_link_id": "SOME_STRING_VALUE",
  "institution_id": "SOME_STRING_VALUE",
  "allowed_institutions": "SOME_STRING_VALUE",
  "blocked_institutions": "SOME_STRING_VALUE",
  "redirect_uri": "SOME_STRING_VALUE",
  "webhook": "SOME_STRING_VALUE",
  "link_tags": "SOME_STRING_VALUE",
  "connect_features": "SOME_STRING_VALUE",
  "custom_sandbox_data": "SOME_STRING_VALUE"
}".data(using: .utf8)!
request.httpBody = jsonData

let task = URLSession.shared.dataTask(with: request) { data, response, error in
    guard let data = data else { return }
    print(String(data: data, encoding: .utf8)!)
}
task.resume()

Response

{
  "link_session_token": "c7318ff7-257c-490e-8242-03a815b223b7"
}

{
  "error_code": "api_error.auth.expired_access_token",
  "error_message": "Access token expired",
  "documentation_url": string
}

{
  "error_code": "link_session_error.forbidden_config",
  "error_message": "Forbidden use of a Connect feature",
  "documentation_url": string
}

Create Link Session

URL

Request

Response

Body Parameters

Headers

Authorization

Responses

201

403

Request

Response