Skip to main content
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>"
}
'
{
  "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",
  "status": "queued",
  "success_count": 123,
  "total_count": 123
}

Authorizations

x-api-key
string
header
required

Body

application/json
file_base64
string
required

Base64 encoded file bytes

filename
string
required

Name of file

Response

Upload job created successfully

created
string<date-time>
error_count
integer
error_details
object
error_message
string | null
filename
string | null
finished_at
string<date-time> | null
heron_id
string
last_updated
string<date-time>
processed_count
integer
results_summary
object
started_at
string<date-time> | null
status
enum<string>
Available options:
queued,
processing,
completed,
failed
success_count
integer
total_count
integer | null