Get Report Status

GET

/public/v3/customers/{customer_id}/report_readiness_statuses/{report_name}

Parameters

ParameterData typeRequired?Description
customer_idstringyesCustomer ID
report_namestringyesName of the report (e.g. insights or forecast)

Query parameters

none

Request Body Parameters

none

Response Body Parameters

ParameterData typeRequired?Description
namestringyesName of the referred report
statusstringyesAllowed:(no_data, not_ready, ready)
account_types[string]yesList of available reports by bank account type ("Business", "Personal")

Request example

1 2 3 curl --location --request GET 'https://api.friendlyscore.com/public/v3/customers/{customer_id}/report_readiness_statuses/{report_name}' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {access_token}'

Response example:

1 2 3 4 5 6 7 { "name": "{report_name}", "status": "ready", "account_types": [ "Personal", "Business" ] }

Was this article helpful?

Friendly Score UK Ltd.

52 Brook Street 1st Floor, Mayfair

London W1K 5DS

Call us on +44 20 3709 6726

Company registered in England

Company number 09168668, ICO ZA111687

VAT registration number 206 9758 80

Authorised and Regulated by the Financial Conduct Authority. (FRN: 781963)