Revoke a publisher, retaining or discarding imported financial history
curl --request DELETE \
--url https://app.sure.am/api/v1/financekit/connections/{id} \
--header 'X-Api-Key: <api-key>'import requests
url = "https://app.sure.am/api/v1/financekit/connections/{id}"
headers = {"X-Api-Key": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://app.sure.am/api/v1/financekit/connections/{id}', 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://app.sure.am/api/v1/financekit/connections/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.sure.am/api/v1/financekit/connections/{id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://app.sure.am/api/v1/financekit/connections/{id}")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sure.am/api/v1/financekit/connections/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"publisher_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending_mapping",
"generation": 2,
"next_sequence": 2,
"open_conflicts": 1,
"stream_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"repair_reason": "<string>",
"last_device_contact_at": "2023-11-07T05:31:56Z",
"last_accepted_at": "2023-11-07T05:31:56Z",
"last_imported_at": "2023-11-07T05:31:56Z",
"last_downstream_at": "2023-11-07T05:31:56Z",
"last_captured_at": "2023-11-07T05:31:56Z",
"accounts": [
{
"source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lineage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mapping_version": 2,
"name": "<string>",
"institution_name": "<string>",
"currency": "<string>",
"accountable_type": "<string>",
"subtype": "<string>",
"ledger_timezone": "<string>",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"pagination": {
"page": 2,
"per_page": 2,
"total_count": 1,
"total_pages": 1
},
"purge_requested_at": "2023-11-07T05:31:56Z",
"purge_completed_at": "2023-11-07T05:31:56Z",
"disposition": "retain"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}FinanceKit
Revoke a publisher, retaining or discarding imported financial history
DELETE
/
api
/
v1
/
financekit
/
connections
/
{id}
Revoke a publisher, retaining or discarding imported financial history
curl --request DELETE \
--url https://app.sure.am/api/v1/financekit/connections/{id} \
--header 'X-Api-Key: <api-key>'import requests
url = "https://app.sure.am/api/v1/financekit/connections/{id}"
headers = {"X-Api-Key": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://app.sure.am/api/v1/financekit/connections/{id}', 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://app.sure.am/api/v1/financekit/connections/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.sure.am/api/v1/financekit/connections/{id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://app.sure.am/api/v1/financekit/connections/{id}")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sure.am/api/v1/financekit/connections/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"publisher_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending_mapping",
"generation": 2,
"next_sequence": 2,
"open_conflicts": 1,
"stream_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"repair_reason": "<string>",
"last_device_contact_at": "2023-11-07T05:31:56Z",
"last_accepted_at": "2023-11-07T05:31:56Z",
"last_imported_at": "2023-11-07T05:31:56Z",
"last_downstream_at": "2023-11-07T05:31:56Z",
"last_captured_at": "2023-11-07T05:31:56Z",
"accounts": [
{
"source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lineage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mapping_version": 2,
"name": "<string>",
"institution_name": "<string>",
"currency": "<string>",
"accountable_type": "<string>",
"subtype": "<string>",
"ledger_timezone": "<string>",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"pagination": {
"page": 2,
"per_page": 2,
"total_count": 1,
"total_pages": 1
},
"purge_requested_at": "2023-11-07T05:31:56Z",
"purge_completed_at": "2023-11-07T05:31:56Z",
"disposition": "retain"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
apiKeyAuthoauth2
API key for authentication. Generate one from your account settings.
Path Parameters
Query Parameters
What happens to the data this connection imported. retain (the default) keeps every account, balance and transaction. discard removes them: accounts FinanceKit created are destroyed, accounts it was linked to are emptied of FinanceKit-sourced entries and rebalanced, and source identities, balance observations and conflicts are deleted. Irreversible, and it removes imported entries the family later reconciled, excluded or edited. Supported dispositions are advertised by GET /api/v1/financekit/capabilities.
Available options:
retain, discard Response
Publisher revoked, discard of imported history accepted
Pattern:
^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$Pattern:
^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$Pattern:
^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$Available options:
pending_mapping, active, repair_required, revoked Required range:
x >= 1Required range:
x >= 1Required range:
x >= 0Pattern:
^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
retain, discard Was this page helpful?