POST
/
api
/
end_users
/
{end_user_id_or_heron_id}
/
finicity
/
request_cashflow_report
curl --request POST \
  --url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/finicity/request_cashflow_report \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "applicant_is_personal_guarantor": true,
  "for_cra_purpose": true,
  "user_type": "personal"
}'

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
end_user_id_or_heron_id
string
required

Body

application/json
​
applicant_is_personal_guarantor
boolean
required
​
for_cra_purpose
boolean
required
​
user_type
enum<string>
required
Available options:
personal,
business

Response

202

OK

Was this page helpful?

Send a Finicity Connect email to an end userTrigger a statement reports generation for an end user