Get Report Status

GET

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

Parameters

Parameter	Data type	Required?	Description
customer_id	string	yes	Customer ID
report_name	string	yes	Name of the report (e.g. insights or forecast)

Query parameters

none

Request Body Parameters

none

Response Body Parameters

Parameter	Data type	Required?	Description
name	string	yes	Name of the referred report
status	string	yes	Allowed:(no_data, not_ready, ready)
account_types	[string]	yes	List 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:

{
  "name": "{report_name}",
  "status": "ready",
  "account_types": [
    "Personal", "Business"
  ]
}

Was this article helpful?

Friendly Score UK Ltd.

84 Brook Street

London W1K 5EH

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: 821100, 781963)