Returns the add account widget's URL
curl --request POST \
--url https://ledgersyncappv2.com/api/v2/account/add/lite \
--header 'Auth-Token: <auth-token>' \
--header 'Content-Type: application/json' \
--data '
{
"username": "<string>",
"redirectUri": "<string>",
"institutionId": "<string>"
}
'import requests
url = "https://ledgersyncappv2.com/api/v2/account/add/lite"
payload = {
"username": "<string>",
"redirectUri": "<string>",
"institutionId": "<string>"
}
headers = {
"Auth-Token": "<auth-token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Auth-Token': '<auth-token>', 'Content-Type': 'application/json'},
body: JSON.stringify({username: '<string>', redirectUri: '<string>', institutionId: '<string>'})
};
fetch('https://ledgersyncappv2.com/api/v2/account/add/lite', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://ledgersyncappv2.com/api/v2/account/add/lite",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'username' => '<string>',
'redirectUri' => '<string>',
'institutionId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Auth-Token: <auth-token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://ledgersyncappv2.com/api/v2/account/add/lite"
payload := strings.NewReader("{\n \"username\": \"<string>\",\n \"redirectUri\": \"<string>\",\n \"institutionId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Auth-Token", "<auth-token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://ledgersyncappv2.com/api/v2/account/add/lite")
.header("Auth-Token", "<auth-token>")
.header("Content-Type", "application/json")
.body("{\n \"username\": \"<string>\",\n \"redirectUri\": \"<string>\",\n \"institutionId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://ledgersyncappv2.com/api/v2/account/add/lite")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Auth-Token"] = '<auth-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"username\": \"<string>\",\n \"redirectUri\": \"<string>\",\n \"institutionId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body"<string>""<string>""<string>"account-api
Returns the add account widget's URL
POST
/
api
/
v2
/
account
/
add
/
lite
Returns the add account widget's URL
curl --request POST \
--url https://ledgersyncappv2.com/api/v2/account/add/lite \
--header 'Auth-Token: <auth-token>' \
--header 'Content-Type: application/json' \
--data '
{
"username": "<string>",
"redirectUri": "<string>",
"institutionId": "<string>"
}
'import requests
url = "https://ledgersyncappv2.com/api/v2/account/add/lite"
payload = {
"username": "<string>",
"redirectUri": "<string>",
"institutionId": "<string>"
}
headers = {
"Auth-Token": "<auth-token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Auth-Token': '<auth-token>', 'Content-Type': 'application/json'},
body: JSON.stringify({username: '<string>', redirectUri: '<string>', institutionId: '<string>'})
};
fetch('https://ledgersyncappv2.com/api/v2/account/add/lite', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://ledgersyncappv2.com/api/v2/account/add/lite",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'username' => '<string>',
'redirectUri' => '<string>',
'institutionId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Auth-Token: <auth-token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://ledgersyncappv2.com/api/v2/account/add/lite"
payload := strings.NewReader("{\n \"username\": \"<string>\",\n \"redirectUri\": \"<string>\",\n \"institutionId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Auth-Token", "<auth-token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://ledgersyncappv2.com/api/v2/account/add/lite")
.header("Auth-Token", "<auth-token>")
.header("Content-Type", "application/json")
.body("{\n \"username\": \"<string>\",\n \"redirectUri\": \"<string>\",\n \"institutionId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://ledgersyncappv2.com/api/v2/account/add/lite")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Auth-Token"] = '<auth-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"username\": \"<string>\",\n \"redirectUri\": \"<string>\",\n \"institutionId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body"<string>""<string>""<string>"Body
application/json
Response
Returns the add account URL widget to be invoked by the client
Set the optional source field to MX to connect a bank via MX (for banks Finicity does not support); omit it (or use FINICITY) for the default Finicity flow. When source=MX, widgetUrl is an MX Connect URL (moneydesktop.com) loaded with the MX Connect widget instead of the Finicity SDK; omit institutionId to let the user search for their bank in the widget.
Call /api/v2/institutions/provider-options first if you do not already know which provider covers the bank.
When the call succeed, returning code 200, grab the content of widgetUrl and make a call to this url
The response is of type string.
