Upload funder policy file for parsing
curl --request POST \
--url https://app.herondata.io/api/broker_funder_policies/upload/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"file_base64": "<string>",
"filename": "<string>"
}
'import requests
url = "https://app.herondata.io/api/broker_funder_policies/upload/"
payload = {
"file_base64": "<string>",
"filename": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({file_base64: '<string>', filename: '<string>'})
};
fetch('https://app.herondata.io/api/broker_funder_policies/upload/', 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.herondata.io/api/broker_funder_policies/upload/",
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([
'file_base64' => '<string>',
'filename' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.herondata.io/api/broker_funder_policies/upload/"
payload := strings.NewReader("{\n \"file_base64\": \"<string>\",\n \"filename\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://app.herondata.io/api/broker_funder_policies/upload/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"file_base64\": \"<string>\",\n \"filename\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/broker_funder_policies/upload/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"file_base64\": \"<string>\",\n \"filename\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"created": "2023-11-07T05:31:56Z",
"error_count": 123,
"error_details": {},
"error_message": "<string>",
"filename": "<string>",
"finished_at": "2023-11-07T05:31:56Z",
"heron_id": "<string>",
"last_updated": "2023-11-07T05:31:56Z",
"processed_count": 123,
"results_summary": {},
"started_at": "2023-11-07T05:31:56Z",
"success_count": 123,
"total_count": 123
}API Reference
Upload funder policy file for parsing
Upload a spreadsheet (XLS, XLSX, CSV) or PDF containing funder policies. The file will be parsed asynchronously and policies will be upserted for the current user. Only one upload job can be active at a time per user.
POST
/
api
/
broker_funder_policies
/
upload
/
Upload funder policy file for parsing
curl --request POST \
--url https://app.herondata.io/api/broker_funder_policies/upload/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"file_base64": "<string>",
"filename": "<string>"
}
'import requests
url = "https://app.herondata.io/api/broker_funder_policies/upload/"
payload = {
"file_base64": "<string>",
"filename": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({file_base64: '<string>', filename: '<string>'})
};
fetch('https://app.herondata.io/api/broker_funder_policies/upload/', 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.herondata.io/api/broker_funder_policies/upload/",
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([
'file_base64' => '<string>',
'filename' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.herondata.io/api/broker_funder_policies/upload/"
payload := strings.NewReader("{\n \"file_base64\": \"<string>\",\n \"filename\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://app.herondata.io/api/broker_funder_policies/upload/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"file_base64\": \"<string>\",\n \"filename\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/broker_funder_policies/upload/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"file_base64\": \"<string>\",\n \"filename\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"created": "2023-11-07T05:31:56Z",
"error_count": 123,
"error_details": {},
"error_message": "<string>",
"filename": "<string>",
"finished_at": "2023-11-07T05:31:56Z",
"heron_id": "<string>",
"last_updated": "2023-11-07T05:31:56Z",
"processed_count": 123,
"results_summary": {},
"started_at": "2023-11-07T05:31:56Z",
"success_count": 123,
"total_count": 123
}Authorizations
Body
application/json
Response
Upload job created successfully
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
queued, processing, completed, failed Was this page helpful?
⌘I