Import Link

Creates a new link with pre-populated accounts and transactions. The new link will be created in an initially disconnected state, with an error code of auth_expired, but all data will be available. As with any disconnected link, the imported link can then be reconnected at any time by starting a new /link-session with existing_link_id set to the link's link_id. Note that the link can be reconnected using any suitable provider.

The imported data has a maximum size limit of 1MB, which corresponds very roughly to about 4000 transactions. The data is processed synchronously, so you can expect a delay of up to 10 seconds before the response is transmitted. You should set generous HTTP read timeouts to avoid disconnecting before the import is complete.

URL

POST

/links/import

Request

curl --request POST \
  --url https://api.moneykit.com/links/import \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"customer_user":{"id":"string","email":{"address":"string","customer_verified_at":"2023-02-16T00:00:00"},"phone":{"number":"6175551212","country":"US","customer_verified_at":"2023-02-16T00:00:00"}},"provider":"mx","institution_id":"chase","accounts":[{"account_id":"74583934","name":"Premier Checking","type":"depository.checking","mask":"3748","balances":{"currency":"USD","available":340.12,"current":445.89,"limit":500,"balance_date":"2021-08-12T15:23:00Z"}}],"transactions":[{"account_id":"74583934","transaction_id":"string","amount":"384.05","date":"2022-02-08","description":"Regina'\''s Mulberry","type":"food_and_drinks.restaurants"}]}'

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer REPLACE_BEARER_TOKEN',
    'content-type': 'application/json'
  },
  body: '{"customer_user":{"id":"string","email":{"address":"string","customer_verified_at":"2023-02-16T00:00:00"},"phone":{"number":"6175551212","country":"US","customer_verified_at":"2023-02-16T00:00:00"}},"provider":"mx","institution_id":"chase","accounts":[{"account_id":"74583934","name":"Premier Checking","type":"depository.checking","mask":"3748","balances":{"currency":"USD","available":340.12,"current":445.89,"limit":500,"balance_date":"2021-08-12T15:23:00Z"}}],"transactions":[{"account_id":"74583934","transaction_id":"string","amount":"384.05","date":"2022-02-08","description":"Regina\'s Mulberry","type":"food_and_drinks.restaurants"}]}'
};

fetch('https://api.moneykit.com/links/import', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import requests

url = "https://api.moneykit.com/links/import"

payload = {
    "customer_user": {
        "id": "string",
        "email": {
            "address": "string",
            "customer_verified_at": "2023-02-16T00:00:00"
        },
        "phone": {
            "number": "6175551212",
            "country": "US",
            "customer_verified_at": "2023-02-16T00:00:00"
        }
    },
    "provider": "mx",
    "institution_id": "chase",
    "accounts": [
        {
            "account_id": "74583934",
            "name": "Premier Checking",
            "type": "depository.checking",
            "mask": "3748",
            "balances": {
                "currency": "USD",
                "available": 340.12,
                "current": 445.89,
                "limit": 500,
                "balance_date": "2021-08-12T15:23:00Z"
            }
        }
    ],
    "transactions": [
        {
            "account_id": "74583934",
            "transaction_id": "string",
            "amount": "384.05",
            "date": "2022-02-08",
            "description": "Regina's Mulberry",
            "type": "food_and_drinks.restaurants"
        }
    ]
}
headers = {
    "Authorization": "Bearer REPLACE_BEARER_TOKEN",
    "content-type": "application/json"
}

response = requests.request("POST", url, json=payload, headers=headers)

print(response.text)

package main

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

func main() {

	url := "https://api.moneykit.com/links/import"

	payload := strings.NewReader("{\"customer_user\":{\"id\":\"string\",\"email\":{\"address\":\"string\",\"customer_verified_at\":\"2023-02-16T00:00:00\"},\"phone\":{\"number\":\"6175551212\",\"country\":\"US\",\"customer_verified_at\":\"2023-02-16T00:00:00\"}},\"provider\":\"mx\",\"institution_id\":\"chase\",\"accounts\":[{\"account_id\":\"74583934\",\"name\":\"Premier Checking\",\"type\":\"depository.checking\",\"mask\":\"3748\",\"balances\":{\"currency\":\"USD\",\"available\":340.12,\"current\":445.89,\"limit\":500,\"balance_date\":\"2021-08-12T15:23:00Z\"}}],\"transactions\":[{\"account_id\":\"74583934\",\"transaction_id\":\"string\",\"amount\":\"384.05\",\"date\":\"2022-02-08\",\"description\":\"Regina's Mulberry\",\"type\":\"food_and_drinks.restaurants\"}]}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")
	req.Header.Add("content-type", "application/json")

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

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.moneykit.com/links/import")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer REPLACE_BEARER_TOKEN'
request["content-type"] = 'application/json'
request.body = "{\"customer_user\":{\"id\":\"string\",\"email\":{\"address\":\"string\",\"customer_verified_at\":\"2023-02-16T00:00:00\"},\"phone\":{\"number\":\"6175551212\",\"country\":\"US\",\"customer_verified_at\":\"2023-02-16T00:00:00\"}},\"provider\":\"mx\",\"institution_id\":\"chase\",\"accounts\":[{\"account_id\":\"74583934\",\"name\":\"Premier Checking\",\"type\":\"depository.checking\",\"mask\":\"3748\",\"balances\":{\"currency\":\"USD\",\"available\":340.12,\"current\":445.89,\"limit\":500,\"balance_date\":\"2021-08-12T15:23:00Z\"}}],\"transactions\":[{\"account_id\":\"74583934\",\"transaction_id\":\"string\",\"amount\":\"384.05\",\"date\":\"2022-02-08\",\"description\":\"Regina's Mulberry\",\"type\":\"food_and_drinks.restaurants\"}]}"

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

import Foundation

let headers = [
  "Authorization": "Bearer REPLACE_BEARER_TOKEN",
  "content-type": "application/json"
]
let parameters = [
  "customer_user": [
    "id": "string",
    "email": [
      "address": "string",
      "customer_verified_at": "2023-02-16T00:00:00"
    ],
    "phone": [
      "number": "6175551212",
      "country": "US",
      "customer_verified_at": "2023-02-16T00:00:00"
    ]
  ],
  "provider": "mx",
  "institution_id": "chase",
  "accounts": [
    [
      "account_id": "74583934",
      "name": "Premier Checking",
      "type": "depository.checking",
      "mask": "3748",
      "balances": [
        "currency": "USD",
        "available": 340.12,
        "current": 445.89,
        "limit": 500,
        "balance_date": "2021-08-12T15:23:00Z"
      ]
    ]
  ],
  "transactions": [
    [
      "account_id": "74583934",
      "transaction_id": "string",
      "amount": "384.05",
      "date": "2022-02-08",
      "description": "Regina's Mulberry",
      "type": "food_and_drinks.restaurants"
    ]
  ]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.moneykit.com/links/import")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()

Response

{
  "link_id": "mk_eqkWN34UEoa2NxyALG8pcV",
  "institution_id": "chase",
  "institution_name": "Chase",
  "institution_avatar": "https://example.com/avatar.png",
  "state": "connected",
  "error_code": null,
    "link_tags": [
    "smoke_test",
    "user_type:admin"
  ],
  "webhook": "https://example.com/webhook",
  "products": {
    "accounts": {
      "refreshed_at": "2023-02-16T09:14:11",
      "last_attempted_at": "2023-02-16T09:14:11",
      "error_code": "rate_limit",
      "error_message": string,
      "unavailable": string
    },
    "account_numbers": {
      "refreshed_at": "2023-02-16T09:14:11",
      "last_attempted_at": "2023-02-16T09:14:11",
      "error_code": "rate_limit",
      "error_message": string,
      "unavailable": string
    },
    "identity": {
      "refreshed_at": "2023-02-16T09:14:11",
      "last_attempted_at": "2023-02-16T09:14:11",
      "error_code": "rate_limit",
      "error_message": string,
      "unavailable": string
    },
    "transactions": {
      "refreshed_at": "2023-02-16T09:14:11",
      "last_attempted_at": "2023-02-16T09:14:11",
      "error_code": "rate_limit",
      "error_message": string,
      "unavailable": string
    },
    "investments": {
      "refreshed_at": "2023-02-16T09:14:11",
      "last_attempted_at": "2023-02-16T09:14:11",
      "error_code": "rate_limit",
      "error_message": string,
      "unavailable": string
    },
    "enrichment": {
      "refreshed_at": "2023-02-16T09:14:11",
      "last_attempted_at": "2023-02-16T09:14:11",
      "error_code": "rate_limit",
      "error_message": string,
      "unavailable": string
    }
  },
  "available_products": [
    "account_numbers"
  ]
}

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

{
  "error_code": "api_error.rate_limit_exceeded",
  "error_message": "Rate limit exceeded",
  "documentation_url": string
}

accounts

: array

required

The accounts to import. Note that these fields are initial values only. After import, the actual values may be normalized and cleaned to fit the MoneyKit schema. Also, values may be updated if the account is synced with a provider later.

customer_user

: object

required

institution_id

: string

required

MoneyKit's unique ID for this institution. If you use a MoneyKit-supported provider, you can also submit the provider name and their institution_id in dotted notation, such as mx.chase or yodlee.30188. If the imported link is synced with a data provider later, it will be connected to this institution. Note that MoneyKit may reconnect the link using any supported provider, not just the one given during this import.

example: chase

example: mx.chase

example: yodlee.30188

provider

: string

The name of the provider from which this data came. The name is helpful, but not required, and can be omitted, particularly if the source is unknown or can't be attributed to one of MoneyKit's providers.

example: mx

Allowed values:

moneykit

finicity

plaid

yodlee

akoya

transactions

: array

required

The transactions to import.

{"params":[{"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":"provider","url_hash":"#provider","description":"The name of the provider from which this data came. The name is helpful, but not\n required, and can be omitted, particularly if the source is unknown or can't be attributed to one of\n MoneyKit's providers."},{"name":"institution_id","url_hash":"#institution_id","description":"MoneyKit's unique ID for this institution. If you use a MoneyKit-supported provider, you can\n also submit the provider name and __their__ institution_id in dotted notation, such as `mx.chase`\n or `yodlee.30188`. If the imported link is synced with a data provider later, it will be connected to\n this institution. Note that MoneyKit may reconnect the link using any supported provider, not just the one\n given during this import."},{"name":"accounts","url_hash":"#accounts","description":"The accounts to import. Note that these fields are initial values only. After import,\n the actual values may be normalized and cleaned to fit the MoneyKit schema. Also, values may be updated\n if the account is synced with a provider later."},{"name":"accounts-account_id","url_hash":"#accounts-account_id","description":"Your internal ID for this account. Must be unique within the imported account batch."},{"name":"accounts-name","url_hash":"#accounts-name","description":"The account name. This value may change if synced with a data provider later."},{"name":"accounts-type","url_hash":"#accounts-type","description":"The account type. It can have any initial value but it will be converted to a MoneyKit\n account type (see <a href=/pages/account_types>Account Types</a>) upon output. The account may change types if it is\n synced with a data provider later."},{"name":"accounts-mask","url_hash":"#accounts-mask","description":"The last four characters (usually digits) of the account number. This field can be\n omitted, but you are strongly encouraged to supply it because it is the most important factor for properly\n connecting new data to this account if it is synced with a data provider later."},{"name":"accounts-balances","url_hash":"#accounts-balances","description":"The balance of funds for this account."},{"name":"accounts-balances-currency","url_hash":"#accounts-balances-currency","description":"A three-character currency code (ISO-4217 or similar, *e.g.*, `USD`, `CAD`) for the account balances."},{"name":"accounts-balances-available","url_hash":"#accounts-balances-available","description":"The amount of funds available for use. Not all institutions report the available balance.\n <p>Note that the available balance typically does not include overdraft limits."},{"name":"accounts-balances-current","url_hash":"#accounts-balances-current","description":"The total amount of funds in the account.\n <p>For credit or loan accounts, a positive number indicates the amount owed by the account holder.\n If the balance is negative (this is rare), this indicates an amount owed **to** the account holder.\n <p>For depository or investment accounts, a positive number is the asset value of the account.\n If the balance is negative (this is rare), this indicates an overdraft or margin condition."},{"name":"accounts-balances-limit","url_hash":"#accounts-balances-limit","description":"The credit limit on the account. Typically this exists only for credit-type accounts.\n <p>In some cases, this may represent the overdraft limit for depository accounts."},{"name":"accounts-balances-balance_date","url_hash":"#accounts-balances-balance_date","description":"The date that the balance was captured at. This may not include a time. When this field is null, the balance was captured at an unknown time."},{"name":"transactions","url_hash":"#transactions","description":"The transactions to import."},{"name":"transactions-account_id","url_hash":"#transactions-account_id","description":"Your internal ID for the account this transaction belongs to. The `account_id` **must** match\n one of the IDs provided in the `accounts` list."},{"name":"transactions-transaction_id","url_hash":"#transactions-transaction_id","description":"Your internal ID for this transaction. If supplied, this ID will be returned as the\n `original_id` of the transaction in future requests."},{"name":"transactions-amount","url_hash":"#transactions-amount","description":"The amount of this transaction, denominated in account currency. Use positive numbers\n for credits (deposits), and negative numbers of debits (withdrawals)."},{"name":"transactions-date","url_hash":"#transactions-date","description":"The effective (posted) date of the transaction, in ISO-8601 format."},{"name":"transactions-description","url_hash":"#transactions-description","description":"A description of this transaction."},{"name":"transactions-type","url_hash":"#transactions-type","description":"A type or category for this transaction. Does not need to match MoneyKit types,\n but see <a href=/pages/categories>Transaction Categories</a> if you want to match our current schema."}]}

Responses

200

Successful Response

link_id

: string

The unique ID for this link.

example: mk_eqkWN34UEoa2NxyALG8pcV

institution_id

: string

The unique ID for the institution this link is connected to.

example: chase

institution_name

: string

The institution name this link is connected to.

example: Chase

institution_avatar

: string

An avatar image for the link's institution.

example: https://example.com/avatar.png

state

: string

The current state of this link. Links that are not yet connected, or which require reconnection, will be in one of the non-connected states. Please note that recently deleted links can be fetched by this function (and will have a state of deleted); however, MoneyKit completely removes deleted links 90 days after deletion, so older deleted links will not be seen after this time.

example: connected

Allowed values:

connecting

awaiting_token_exchange

connected

deleted

error

error_code

: string

The type of error, if the link is in the error state. See Errors for an explanation of error codes.

Allowed values:

system_error

provider_error

institution_error

user_error

auth_expired

incomplete

no_accounts

user_setup_required

invalid_credentials

user_oauth_denied

user_input_incorrect

last_synced_at

: string

deprecated

An ISO-8601 timestamp indicating the last time that the link was updated.

format:

date-time

example: 2023-02-16T09:14:11

provider

: string

The provider that most recently facilitated the creation of this link. Note that MoneyKit may switch providers if necessary to provide continuous access to the institution.

example: mx

Allowed values:

moneykit

finicity

plaid

yodlee

akoya

link_tags

: array

Arbitrary strings used to describe this link.

429

Rate limit exceeded.

error_code

: string

default: "api_error.rate_limit_exceeded"

Allowed values:

api_error.rate_limit_exceeded

error_message

: string

Error message

default: "Rate limit exceeded"

documentation_url

: string

Request

curl --request POST \
  --url https://api.moneykit.com/links/import \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"customer_user":{"id":"string","email":{"address":"string","customer_verified_at":"2023-02-16T00:00:00"},"phone":{"number":"6175551212","country":"US","customer_verified_at":"2023-02-16T00:00:00"}},"provider":"mx","institution_id":"chase","accounts":[{"account_id":"74583934","name":"Premier Checking","type":"depository.checking","mask":"3748","balances":{"currency":"USD","available":340.12,"current":445.89,"limit":500,"balance_date":"2021-08-12T15:23:00Z"}}],"transactions":[{"account_id":"74583934","transaction_id":"string","amount":"384.05","date":"2022-02-08","description":"Regina'\''s Mulberry","type":"food_and_drinks.restaurants"}]}'

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer REPLACE_BEARER_TOKEN',
    'content-type': 'application/json'
  },
  body: '{"customer_user":{"id":"string","email":{"address":"string","customer_verified_at":"2023-02-16T00:00:00"},"phone":{"number":"6175551212","country":"US","customer_verified_at":"2023-02-16T00:00:00"}},"provider":"mx","institution_id":"chase","accounts":[{"account_id":"74583934","name":"Premier Checking","type":"depository.checking","mask":"3748","balances":{"currency":"USD","available":340.12,"current":445.89,"limit":500,"balance_date":"2021-08-12T15:23:00Z"}}],"transactions":[{"account_id":"74583934","transaction_id":"string","amount":"384.05","date":"2022-02-08","description":"Regina\'s Mulberry","type":"food_and_drinks.restaurants"}]}'
};

fetch('https://api.moneykit.com/links/import', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import requests

url = "https://api.moneykit.com/links/import"

payload = {
    "customer_user": {
        "id": "string",
        "email": {
            "address": "string",
            "customer_verified_at": "2023-02-16T00:00:00"
        },
        "phone": {
            "number": "6175551212",
            "country": "US",
            "customer_verified_at": "2023-02-16T00:00:00"
        }
    },
    "provider": "mx",
    "institution_id": "chase",
    "accounts": [
        {
            "account_id": "74583934",
            "name": "Premier Checking",
            "type": "depository.checking",
            "mask": "3748",
            "balances": {
                "currency": "USD",
                "available": 340.12,
                "current": 445.89,
                "limit": 500,
                "balance_date": "2021-08-12T15:23:00Z"
            }
        }
    ],
    "transactions": [
        {
            "account_id": "74583934",
            "transaction_id": "string",
            "amount": "384.05",
            "date": "2022-02-08",
            "description": "Regina's Mulberry",
            "type": "food_and_drinks.restaurants"
        }
    ]
}
headers = {
    "Authorization": "Bearer REPLACE_BEARER_TOKEN",
    "content-type": "application/json"
}

response = requests.request("POST", url, json=payload, headers=headers)

print(response.text)

package main

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

func main() {

	url := "https://api.moneykit.com/links/import"

	payload := strings.NewReader("{\"customer_user\":{\"id\":\"string\",\"email\":{\"address\":\"string\",\"customer_verified_at\":\"2023-02-16T00:00:00\"},\"phone\":{\"number\":\"6175551212\",\"country\":\"US\",\"customer_verified_at\":\"2023-02-16T00:00:00\"}},\"provider\":\"mx\",\"institution_id\":\"chase\",\"accounts\":[{\"account_id\":\"74583934\",\"name\":\"Premier Checking\",\"type\":\"depository.checking\",\"mask\":\"3748\",\"balances\":{\"currency\":\"USD\",\"available\":340.12,\"current\":445.89,\"limit\":500,\"balance_date\":\"2021-08-12T15:23:00Z\"}}],\"transactions\":[{\"account_id\":\"74583934\",\"transaction_id\":\"string\",\"amount\":\"384.05\",\"date\":\"2022-02-08\",\"description\":\"Regina's Mulberry\",\"type\":\"food_and_drinks.restaurants\"}]}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")
	req.Header.Add("content-type", "application/json")

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

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.moneykit.com/links/import")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer REPLACE_BEARER_TOKEN'
request["content-type"] = 'application/json'
request.body = "{\"customer_user\":{\"id\":\"string\",\"email\":{\"address\":\"string\",\"customer_verified_at\":\"2023-02-16T00:00:00\"},\"phone\":{\"number\":\"6175551212\",\"country\":\"US\",\"customer_verified_at\":\"2023-02-16T00:00:00\"}},\"provider\":\"mx\",\"institution_id\":\"chase\",\"accounts\":[{\"account_id\":\"74583934\",\"name\":\"Premier Checking\",\"type\":\"depository.checking\",\"mask\":\"3748\",\"balances\":{\"currency\":\"USD\",\"available\":340.12,\"current\":445.89,\"limit\":500,\"balance_date\":\"2021-08-12T15:23:00Z\"}}],\"transactions\":[{\"account_id\":\"74583934\",\"transaction_id\":\"string\",\"amount\":\"384.05\",\"date\":\"2022-02-08\",\"description\":\"Regina's Mulberry\",\"type\":\"food_and_drinks.restaurants\"}]}"

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

import Foundation

let headers = [
  "Authorization": "Bearer REPLACE_BEARER_TOKEN",
  "content-type": "application/json"
]
let parameters = [
  "customer_user": [
    "id": "string",
    "email": [
      "address": "string",
      "customer_verified_at": "2023-02-16T00:00:00"
    ],
    "phone": [
      "number": "6175551212",
      "country": "US",
      "customer_verified_at": "2023-02-16T00:00:00"
    ]
  ],
  "provider": "mx",
  "institution_id": "chase",
  "accounts": [
    [
      "account_id": "74583934",
      "name": "Premier Checking",
      "type": "depository.checking",
      "mask": "3748",
      "balances": [
        "currency": "USD",
        "available": 340.12,
        "current": 445.89,
        "limit": 500,
        "balance_date": "2021-08-12T15:23:00Z"
      ]
    ]
  ],
  "transactions": [
    [
      "account_id": "74583934",
      "transaction_id": "string",
      "amount": "384.05",
      "date": "2022-02-08",
      "description": "Regina's Mulberry",
      "type": "food_and_drinks.restaurants"
    ]
  ]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.moneykit.com/links/import")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()

Response

{
  "link_id": "mk_eqkWN34UEoa2NxyALG8pcV",
  "institution_id": "chase",
  "institution_name": "Chase",
  "institution_avatar": "https://example.com/avatar.png",
  "state": "connected",
  "error_code": null,
    "link_tags": [
    "smoke_test",
    "user_type:admin"
  ],
  "webhook": "https://example.com/webhook",
  "products": {
    "accounts": {
      "refreshed_at": "2023-02-16T09:14:11",
      "last_attempted_at": "2023-02-16T09:14:11",
      "error_code": "rate_limit",
      "error_message": string,
      "unavailable": string
    },
    "account_numbers": {
      "refreshed_at": "2023-02-16T09:14:11",
      "last_attempted_at": "2023-02-16T09:14:11",
      "error_code": "rate_limit",
      "error_message": string,
      "unavailable": string
    },
    "identity": {
      "refreshed_at": "2023-02-16T09:14:11",
      "last_attempted_at": "2023-02-16T09:14:11",
      "error_code": "rate_limit",
      "error_message": string,
      "unavailable": string
    },
    "transactions": {
      "refreshed_at": "2023-02-16T09:14:11",
      "last_attempted_at": "2023-02-16T09:14:11",
      "error_code": "rate_limit",
      "error_message": string,
      "unavailable": string
    },
    "investments": {
      "refreshed_at": "2023-02-16T09:14:11",
      "last_attempted_at": "2023-02-16T09:14:11",
      "error_code": "rate_limit",
      "error_message": string,
      "unavailable": string
    },
    "enrichment": {
      "refreshed_at": "2023-02-16T09:14:11",
      "last_attempted_at": "2023-02-16T09:14:11",
      "error_code": "rate_limit",
      "error_message": string,
      "unavailable": string
    }
  },
  "available_products": [
    "account_numbers"
  ]
}

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

{
  "error_code": "api_error.rate_limit_exceeded",
  "error_message": "Rate limit exceeded",
  "documentation_url": string
}

Import Link

URL

Request

Response

Body Parameters

Authorization

Responses

200

429

Request

Response