Documentation
/api/accountinfo
This API endpoint returns the current account info and has no cost
Request
https://convert-ixbrl.co.uk/api/accountinfo?outputformat=json
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 |
string | no | Shows the available credits |
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 |