Documentation
/api/accountinfo
This API endpoint is free to call and returns the current account info
Request
https://convert-ixbrl.co.uk/api/accountinfo&apiversion=1
Authentication
This endpoint requires the authentication header to be supplied. See the authentication section.
Request Parameters
companyNumber Type Optional Description
apiVersion
 string No API Version, currently on "1"
Response JSON
Name Type Nullable Description
liveCredits
 integer no Contains remaining credits or 0 if there are no available credits. Beyond the trial period, you either need available credits or an active package to access company financials.
success
 boolean no Contains
true
if the request was successful,
false
if there was an error.
error
 string yes Contains an error message if the request was unsuccessful or null if it was successful.
accountCreatedDate
 string no Date of account creation
activeProduct
 string yes Name of currently active product, if any
activeProductExpiry
 string yes Expiry or next renewal date of currently active product. "Product" refers to the subscription or non-subscription limited access packages.
accountId
 string yes Email address registered for this account