HTTP errors per endpoint
POST /token
/token| Status code | Response title/detail | Action |
|---|---|---|
| 403 | Your account has been disabled. Please contact Basiq support. | Get in touch with the Customer Success to enable your account. |
| 500 | Internal server error | There has been some internal error, possibly within the AWS architecture. You'll have to try again and seek assistance from Customer Success if it continues. |
| 400 | Authorization header parameter is required | Provide a valid key-value pair {"Authorization" : " Basic YOUR_API_KEY" } inside request header. |
| 400 | Version 0.9 is no longer supported. Please upgrade to the latest version | Provide a valid basiq-version (2.0 - 2.1) |
| 400 | Basiq-version must be specified in HTTP request header | Provide a valid basiq-version (2.0 - 2.1) |
| 404 | Unable to authenticate. Please, check your API key | Provide a valid authorization header. This can happen if your API key is deleted, or your application is deleted, or if you use API key from dev environment in production. |
| 400 | Invalid authorization header | Provide a valid key-value pair {"Authorization" : " Basic YOUR_API_KEY" } inside request header. |
| 403 | Invalid request | Forbidden. There have been too many requests for the token endpoint within a 5 minute period from a specific IP address. |
POST /users
/users| Status code | Response title/detail | Action |
|---|---|---|
| 401 | Invalid authorization token. | Provide a key-value pair {"authorization" : " Bearer YOUR_ACCESS_TOKEN" } inside request header and provide key-value pair "email" : " your email" or "mobile" : "your mobile" or both inside request body |
| 400 | Posted user is not in valid format. | Provide valid key-value pair inside request body |
| 400 | One of 'email' or 'mobile' is required. | Provide key-value pair "email" : " your email" or "mobile" : "your mobile" or both inside request body |
| 400 | Provided email is in bad format. | Provide correct format of email inside request body |
| 400 | Provided mobile is in bad format. | Provide correct format of mobile inside request body |
| 403 | Token has expired | Get a new access token on /token endpoint |
| 403 | Access to this resource is forbidden | Incorrect/missing scope set for the token you are using, You likely need to supply scope=SERVER_ACCESS. Make sure when you provide scope you are setting this in the body and not as a request header. |
| 400 | Accept type is not supported | Provide a valid accept header |
| 400 | Business name is required when business number is provided. | Provide business name |
| 503 | Service is currently unavailable. Please try again later. | Try again later, and if problem persists reach out to Customer Success |
| 400 | Posted user is not in valid format. | Provide a valid format of posted user |
GET /users/{userId}
/users/{userId}| Status code | Response title/detail | Action |
|---|---|---|
| 401 | Invalid authorization token. | Provide a key-value pair {"authorization" : " Bearer YOUR_ACCESS_TOKEN" } inside request header and provide key-value pair "email" : " your email" or "mobile" : "your mobile" or both inside request body |
| 400 | User ID value is not valid | Check you are providing a valid userId in the URL |
| 404 | Requested user does not exist. | userId does not exist... Provide correct userId in URL |
| 403 | Token has expired | Get a new access token on /token endpoint |
| 400 | Accept type application/json is not supported on requested endpoint. | Provide a valid accept type |
| 401 | You are not authorized to access this resource | Ensure you the token you're using is valid for use with the userId in the URL |
| 500 | Internal server error. Please contact support. | Contact Customer Success |
POST /users/{userId}
/users/{userId}| Status code | Response title/detail | Action |
|---|---|---|
| 400 | One of 'email' or 'mobile' is required. | Provide email OR mobile in request body |
| 400 | "Provided mobile is in bad format." | Provide correct format of mobile phone in request body |
| 400 | Provided email is in bad format. | Provide correct format of email in request body |
| 401 | Invalid authorization token. | Provide authorization in request header |
| 400 | User ID value is not valid | Provide a valid userId in URL |
| 403 | Token has expired | Get a new access token from '/token' endpoint |
| 403 | Access to this resource is forbidden` | Incorrect/missing scope set for the token you are using, You likely need to supply scope=SERVER_ACCESS. Make sure when you provide scope you are setting this in the body and not as a request header. |
| 400 | Accept type application/json is not supported on requested endpoint. | Provide a valid accept header |
| 400 | User ID not supplied | Provide userId |
| 400 | Posted user is not in valid format. | Provide a valid userId |
| 404 | Requested user does not exist. | This user is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 500 | Internal server error. Please contact support. | Contact Customer Success |
| 503 | Service is currently unavailable. Please try again later. | Please try again. If problem persists get in touch with Customer Success. |
DELETE /users/{userId}
/users/{userId}| Status code | Response title/detail | Action |
|---|---|---|
| 403 | Missing Authentication Token | Provide authorization token in request header |
| 404 | `Requested user does not exist.' | This user is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 400 | User ID value is not valid | Provide a valid userId in URL |
| 401 | Invalid authorization token. | Provide authorization in request header |
| 403 | Token has expired | Get a new access token on /token endpoint |
| 400 | Accept type application/json is not supported on requested endpoint. | Provide a valid accept header |
| 400 | User ID not supplied` | Provide userID |
| 500 | Internal server error. Please contact support. | Please contact Customer Success |
| 503 | Service is currently unavailable. Please try again later. | Please wait 5 minutes and try again. If problem persists please contact Customer Success |
POST /users/{userId}/connections
/users/{userId}/connections| Status code | Response body | Action |
|---|---|---|
| 401 | Invalid authorization token. | provide key-value pair {"authorization" : " Bearer YOUR_ACCESS_TOKEN" } inside request header |
| 400 | Login ID parameter is required. | Provide valid {"loginId" }inside request body |
| 400 | Password parameter is required. | Provide valid {"password" } inside request body |
| 400 | Institution ID parameter is required. | Provide valid {"institutionId"} inside request body |
| 400 | Posted connection is not in valid format. | Provide valid request body, not empty body |
| 415 | Content type application/json is not supported on requested endpoint. | Provide content type |
| 403 | Token has expired | Get a new access token on /token endpoint |
| 400 | Requested institution does not exist. | Provide a valid institutionId |
| 400 | Accept type application/json is not supported on requested endpoint. | Provide a valid accept header |
| 401 | Unauthorized access | Ensure you the token you're using is valid for use with the userId in the URL |
| 400 | User ID value is not valid | Provide a valid userId |
| 403 | Please contact us to have your API key enabled for Connections. | You currently only have a sandbox account and need to be enabled for live data beore you can connect real institutions. Please contact Customer Support to do so. |
| 404 | Requested resource is not found | This user is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 400 | The institution you are trying to connect to is currently disabled. Our developers have been notified and are working to have the issue resolved. You can check the state each institution via the /institutions/:id api. | We are having issues with this institutions and are working on it. You can check the status of it using the status page on your dashboard or by calling the /institutions endpoint |
| 503 | Service is currently unavailable. Please try again later. | Service is unavailable. Please try again in 5 minutes. If the issue persists please contact Customer Success. |
| 500 | Internal server error. Please contact support. | Please try again in 5 minutes. If the issue persists please contact Customer Success. |
| 403 | Limit reached for sandbox connections. | Sandbox connections are limited and you have reached that limit. Please reach out to CS to increase your limit. |
GET /users/{userId}/connections
/users/{userId}/connections| Status code | Response title/detail | Action |
|---|---|---|
| 403 | Access to this resource is forbidden | Incorrect/missing scope set for the token you are using, You likely need to supply scope=SERVER_ACCESS. Make sure when you provide scope you are setting this in the body and not as a request header. |
| 400 | Accept type application/json is not supported on requested endpoint. | Provide a valid accept header |
| 400 | User ID not supplied | Provide a userId |
| 400 | User ID value is not valid | Provide a valid userID |
| 404 | Requested user does not exist. | This user is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 503 | Service is currently unavailable. Please try again later. | Try again in 5 minutes. If problem persists contact customer success. |
| 500 | Internal server error. Please contact support. | Contact the customer success team, |
POST /users/{userId}/connections/refresh
/users/{userId}/connections/refresh| Status code | Response title/detail | Action |
|---|---|---|
| 401 | Invalid authorization token. | Provide key-value pair {"authorization" : " Bearer YOUR_ACCESS_TOKEN" } inside request header |
| 400 | Accept type application/json is not supported on requested endpoint. | Provide a valid accept header |
| 400 | User ID not supplied | Provide userId parameter |
| 403 | Access to this resource is forbidden | Incorrect/missing scope set for the token you are using, You likely need to supply scope=SERVER_ACCESS. Make sure when you provide scope you are setting this in the body and not as a request header. |
| 400 | User ID value is not valid | Provide a valid userId |
| 404 | Requested user does not exist. | This user is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 500 | Internal server error. Please contact support. | Please contact support. |
GET /jobs/{jobId}
/jobs/{jobId}| Status code | Response title/detail | Action |
|---|---|---|
| 401 | Invalid authorization token. | Provide key-value pair {"authorization" : " Bearer YOUR_ACCESS_TOKEN" } inside request header |
| 403 | Token has expired | Get a new access token on /token endpoint |
| 400 | Job ID value is not valid | Provide a valid jobId |
| 404 | Requested resource is not found | This job is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 400 | Accept type application/json is not supported on requested endpoint. | Provide a valid accept header |
| 400 | Job ID not supplied | Provide a jobId |
| 404 | Requested user does not exist. | This user is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 500 | Internal server error. Please contact support. | Please contact Customer Success |
| 403 | Access to this resource is forbidden | Incorrect/missing scope set for the token you are using, You likely need to supply scope=SERVER_ACCESS. Make sure when you provide scope you are setting this in the body and not as a request header. |
GET /users/{userId}/jobs
/users/{userId}/jobs| Status code | Response title/detail | Action |
|---|---|---|
| 401 | Invalid authorization token. | Provide key-value pair {"authorization" : " Bearer YOUR_ACCESS_TOKEN" } inside request header |
| 400 | User ID value is not valid | Provide a valid userID |
| 403 | Token has expired | Get a new access token on /token endpoint |
| 403 | Access to this resource is forbidden | Incorrect/missing scope set for the token you are using, You likely need to supply scope=SERVER_ACCESS. Make sure when you provide scope you are setting this in the body and not as a request header. |
| 400 | Accept type application/json is not supported on requested endpoint. | Provide a valid accept header |
| 404 | Requested user does not exist. | This user is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 404 | Cause: Invalid version for endpoint Body: Route not found for this API version. | |
POST /users/{userId}/connections/{connectionId}
/users/{userId}/connections/{connectionId}| Status code | Response title/detail | Action |
|---|---|---|
| 400 | User ID value is not valid | Provide a valid userID |
| 401 | Invalid authorization token. | Provide key-value pair {"authorization" : " Bearer YOUR_ACCESS_TOKEN" } inside request header |
| 403 | Token has expired | Get a new access token on /token endpoint |
| 403 | Invalid request | Provide a valid userId in URL. This error can happen if you don't provide userId in URL (for example /users//connections/connectionId) |
| 400 | Connection ID value is not valid | Provide a valid connectionId in URL, it may be formatted incorrectly. |
| 403 | Access to this resource is forbidden | Incorrect/missing scope set for the token you are using, You likely need to supply scope=SERVER_ACCESS. Make sure when you provide scope you are setting this in the body and not as a request header. |
| 400 | Accept type application/json is not supported on requested endpoint. | Provide a valid accept header |
| 415 | Content type invalid-content-type is not supported on requested endpoint. | Provide a valid content type |
| 401 | Unauthorized access | Ensure you the token you're using is valid for use with the resources in the URL |
| 400 | Posted connection is not in valid format. | Provide valid request body, not empty body |
| 400 | Password value is not valid | Please provide correctly formatted password |
| 404 | Requested resource is not found | This connection is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 400 | Connection type is not Web | The connection type is not web so this is not supported. |
| 400 | Requested resource is not found | This resource is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 400 | The institution you are trying to connect to is currently disabled. Our developers have been notified and are working to have the issue resolved. You can check the state each institution via the /institutions/:id api. | We are having issues with this institutions and are working on it. You can check the status of it using the status page on your dashboard or by calling the /institutions endpoint |
| 404 | Requested resource is not found | This resource is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 500 | Internal server error. Please contact support. | Please contact Customer Success |
| 503 | Service is currently unavailable. Please try again later. | Please try again. If problem persists get in touch with Customer Success. |
DELETE /users/{userId}/connections/{connectionId}
/users/{userId}/connections/{connectionId}| 400 | User ID value is not valid | Provide a valid userID |
|---|---|---|
| 401 | Invalid authorization token. | Provide key-value pair {"authorization" : " Bearer YOUR_ACCESS_TOKEN" } inside request header |
| 403 | Token has expired | Get a new access token on /token endpoint |
| 403 | Invalid request | Provide a valid userId in URL |
| 400 | Connection ID value is not valid | Provide a valid connectionId in URL |
| 403 | Access to this resource is forbidden | Incorrect/missing scope set for the token you are using, You likely need to supply scope=SERVER_ACCESS. Make sure when you provide scope you are setting this in the body and not as a request header. |
| 400 | Connection ID not supplied | Provide connection ID |
| 404 | Requested resource is not found | This resource is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 404 | Requested user does not exist. | This user is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 500 | Internal server error. Please contact support. | Please contact Customer Success |
| 503 | Service is currently unavailable. Please try again later. | Please try again. If problem persists get in touch with Customer Success. |
GET /users/{userId}/connections/{connectionId}
/users/{userId}/connections/{connectionId}| Status code | Response title/detail | Action |
|---|---|---|
| 401 | Invalid authorization token. | Provide key-value pair {"authorization" : " Bearer YOUR_ACCESS_TOKEN" } inside request header |
| 400 | User ID value is not valid | Provide a valid userID |
| 400 | Connection ID value is not valid | Provide a valid connectionId in URL |
| 404 | Requested resource is not found | This resource is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 403 | Token has expired | Get a new access token on /token endpoint |
| 403 | Access to this resource is forbidden | Incorrect/missing scope set for the token you are using, You likely need to supply scope=SERVER_ACCESS. Make sure when you provide scope you are setting this in the body and not as a request header. |
| 400 | Accept type application/json is not supported on requested endpoint. | Provide a valid accept header |
| 401 | Unauthorized access | Ensure you the token you're using is valid for use with the resources in the URL |
| 400 | Connection ID not supplied | Provide connection ID |
| 500 | Internal server error. Please contact support. | Please contact Customer Success |
| 503 | Service is currently unavailable. Please try again later. | Please try again. If problem persists get in touch with Customer Success. |
POST /users/{userId}/connections/{connectionId}/refresh
/users/{userId}/connections/{connectionId}/refresh| Status code | Response title/detail | Action |
|---|---|---|
| 401 | Invalid authorization token. | Provide key-value pair {"authorization" : " Bearer YOUR_ACCESS_TOKEN" } inside request header |
| 403 | Token has expired | Get a new access token on /token endpoint |
| 400 | User ID value is not valid | Provide a valid userID |
| 404 | Requested user does not exist. | This user is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 400 | Connection ID not supplied | Provide a connectionId in URL |
| 400 | Connection ID value is not valid | Provide a valid connectionId in URL |
| 400 | Accept type application/json is not supported on requested endpoint. | Provide a valid accept header |
| 403 | Access to this resource is forbidden | Incorrect/missing scope set for the token you are using, You likely need to supply scope=SERVER_ACCESS. Make sure when you provide scope you are setting this in the body and not as a request header. |
| 404 | Requested resource is not found | This resource is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 400 | Connection type is not Web | Connection type is not valid therefore not compatible. |
| 400 | Cannot login to target institution using supplied credentials. Please check credentials and try again. | The credentials are invalid. This could be because a user has changed their password. You may need to prompt user to resupply new credentials. |
| 403 | Please contact us to have your API key enabled for Connections. | You currently only have a sandbox account and need to be enabled for live data beore you can connect real institutions. Please contact Customer Support to do so. |
| 500 | Internal server error. Please contact support. | Please contact Customer Success |
| 503 | Service is currently unavailable. Please try again later. | Please try again. If problem persists get in touch with Customer Success. |
GET /users/{userId}/accounts
/users/{userId}/accounts| Status code | Response title/detail | Action |
|---|---|---|
| 403 | Token has expired | Get a new access token on /token endpoint |
| 401 | Invalid authorization token. | Provide key-value pair {"authorization" : " Bearer YOUR_ACCESS_TOKEN" } inside request header |
| 400 | User ID value is not valid | Provide a valid userID |
| 404 | Requested user does not exist. | This user is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 403 | Access to this resource is forbidden | Incorrect/missing scope set for the token you are using, You likely need to supply scope=SERVER_ACCESS. Make sure when you provide scope you are setting this in the body and not as a request header. |
| 400 | Accept type application/json is not supported on requested endpoint. | Provide a valid accept header |
| 404 | Requested resource is not found | This resource is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 400 | Requested connection does not exist. | This can occur if the connection type is not "web" |
| 500 | Internal server error. Please contact support. | Please contact Customer Success |
GET /users/{userId}/accounts/{accountId}
/users/{userId}/accounts/{accountId}| Status code | Response title/detail | Action |
|---|---|---|
| 403 | Token has expired | Get a new access token on /token endpoint |
| 401 | Invalid authorization token. | Provide key-value pair {"authorization" : " Bearer YOUR_ACCESS_TOKEN" } inside request header |
| 400 | Account ID value is not valid | Provide a valid accountId in URL |
| 404 | Requested resource is not found | This resource is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 400 | User ID value is not valid | Provide a valid userID in URL |
| 403 | Access to this resource is forbidden | Incorrect/missing scope set for the token you are using, You likely need to supply scope=SERVER_ACCESS. Make sure when you provide scope you are setting this in the body and not as a request header. |
| 400 | Accept type application/json is not supported on requested endpoint. | Provide a valid accept header |
| 400 | Account ID not supplied | Provide valid accountId |
| 400 | User ID value is not valid | Provide a valid userID |
| 404 | Requested user does not exist. | This user is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 500 | Internal server error. Please contact support. | Please contact Customer Success |
GET /users/{userId}/transactions
/users/{userId}/transactions| Status code | Response title/detail | Action |
|---|---|---|
| 403 | Token has expired | Get a new access token on /token endpoint |
| 401 | Invalid authorization token. | Provide key-value pair {"authorization" : " Bearer YOUR_ACCESS_TOKEN" } inside request header |
| 400 | User ID value is not valid | Provide a valid userID in URL |
| 400 | User ID value is not valid | Provide a valid userID |
| 404 | Requested user does not exist. | This user is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 403 | Access to this resource is forbidden | Incorrect/missing scope set for the token you are using, You likely need to supply scope=SERVER_ACCESS. Make sure when you provide scope you are setting this in the body and not as a request header. |
| 400 | Accept type application/json is not supported on requested endpoint. | Provide a valid accept header |
| 400 | Next value is not valid | Provide a valid value for parameter next in URL |
| 400 | Limit value is not valid | Provide a valid value for parameter limit in URL |
| 400 | Maximum limit allowed is 500 | Provide a value for parameter limit that is not greater than 500 |
| 400 | PostDate is not valid | Provide a valid value for parameter PostDate |
| 500 | Internal server error. Please contact support. | Please contact Customer Success |
GET /users/{userId}/transactions/{transactionId}
/users/{userId}/transactions/{transactionId}| Status code | Response title/detail | Action |
|---|---|---|
| 403 | Token has expired | Get a new access token on /token endpoint |
| 401 | Invalid authorization token. | Provide key-value pair {"authorization" : " Bearer YOUR_ACCESS_TOKEN" } inside request header |
| 400 | User ID not supplied | Provide userId in URL |
| 400 | User ID value is not valid | Provide a valid userID in the URL |
| 404 | Requested user does not exist. | This user is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 400 | Transaction ID value is not valid | Provide valid transactionId in URL |
| 404 | Requested resource is not found | This resource is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 400 | Accept type application/json is not supported on requested endpoint. | Provide a valid accept header |
| 403 | Access to this resource is forbidden | Incorrect/missing scope set for the token you are using, You likely need to supply scope=SERVER_ACCESS. Make sure when you provide scope you are setting this in the body and not as a request header. |
| 400 | Transaction ID not supplied | Provide transaction ID in URL |
| 503 | Service is currently unavailable. Please try again later. | Please try again. If problem persists get in touch with Customer Success. |
| 500 | Internal server error. Please contact support. | Please contact Customer Success |
GET /institutions
/institutions| Status code | Response title/detail | Action |
|---|---|---|
| 401 | Invalid authorization token. | Provide key-value pair {"authorization" : " Bearer YOUR_ACCESS_TOKEN" } inside request header |
| 403 | Token has expired | Get a new access token on /token endpoint |
GET /institutions/{institutionId}
/institutions/{institutionId}| Status code | Response title/detail | Action |
|---|---|---|
| 401 | Invalid authorization token. | Provide key-value pair {"authorization" : " Bearer YOUR_ACCESS_TOKEN" } inside request header |
| 403 | Token has expired | Get a new access token on /token endpoint |
| 400 | Supplied Institution ID is not valid | provide valid institutionId in URL |
| 404 | Requested resource is not found | This resource is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
POST /users/{userId}/affordability
/users/{userId}/affordability| Status code | Response title/detail | Action |
|---|---|---|
| 401 | Invalid authorization token. | Provide key-value pair {"authorization" : " Bearer YOUR_ACCESS_TOKEN" } inside request header |
| 403 | Token has expired | Get a new access token on /token endpoint |
| 400 | User ID value is not valid | Provide a valid userID |
| 404 | Requested resource is not found | These accounts are unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 400 | Accept type application/json is not supported on requested endpoint. | Provide a valid accept header |
| 403 | Access to this resource is forbidden | Incorrect/missing scope set for the token you are using, You likely need to supply scope=SERVER_ACCESS. Make sure when you provide scope you are setting this in the body and not as a request header. |
| 401 | Unauthorized access | Ensure you the token you're using is valid for use with the resources in the URL |
| 400 | Dates not in valid format. Date has to be in yyyy-mm-dd format | Provide a valid dates format in yyyy-mm-dd format |
| 400 | fromDate not in valid format. Date has to be in yyyy-mm-dd format | Provide a valid dates format in yyyy-mm-dd format |
| 400 | toDate not in valid format. Date has to be in yyyy-mm-dd format | Provide a valid toDate format in yyyy-mm-dd format |
| 400 | toDate must be be after or equal to fromDate | Ensure you are sendign a |
| 404 | Requested user does not exist. | This user is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 500 | Internal server error. Please contact support. | Please contact Customer Success |
| 400 | User's accounts contains mixed currencies | User's accounts contains mixed currencies which is causing issues with aggregation. Remove these accounts |
GET /users/{userId}/affordability/{snapshotId}
/users/{userId}/affordability/{snapshotId}| Status code | Response title/detail | Action |
|---|---|---|
| 401 | Invalid authorization token. | Provide key-value pair {"authorization" : " Bearer YOUR_ACCESS_TOKEN" } inside request header |
| 403 | Token has expired | Get a new access token on /token endpoint |
| 400 | User ID value is not valid | Provide a valid userID |
| 400 | Snapshot ID value is not valid | Provide a valid snapshotId in URL |
| 400 | Accept type is not supported | Provide a valid accept type |
| 403 | Access to this resource is forbidden | Incorrect/missing scope set for the token you are using, You likely need to supply scope=SERVER_ACCESS. Make sure when you provide scope you are setting this in the body and not as a request header. |
| 401 | Unauthorized access | Ensure you the token you're using is valid for use with the resources in the URL |
| 400 | Snapshot ID value is not supplied | Missing snapshotId, please provide. |
| 404 | Requested user does not exist. | This user is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 500 | Internal server error. Please contact support. | Please contact Customer Success |
| 403 | Please contact us to have your API key enabled for Income Summary. | You are not enabled for this feature. Please contact Customer Success to have this enabled. |
| 503 | Service is currently unavailable. Please try again later. | Please try again. If problem persists get in touch with Customer Success. |
POST users/{userId}/income
users/{userId}/income| Status code | Response title/detail | Action |
|---|---|---|
| 401 | Invalid authorization token. | Provide key-value pair {"authorization" : " Bearer YOUR_ACCESS_TOKEN" } inside request header |
| 403 | Token has expired | Get a new access token on /token endpoint |
| 400 | User ID value is not valid | Provide a valid userID |
| 400 | Accept type application/json is not supported on requested endpoint. | Provide a valid accept header |
| 403 | Access to this resource is forbidden | Incorrect/missing scope set for the token you are using, You likely need to supply scope=SERVER_ACCESS. Make sure when you provide scope you are setting this in the body and not as a request header. |
| 401 | Unauthorized access | Ensure you the token you're using is valid for use with the resources in the URL |
| 400 | Dates not in valid format. Date has to be in yyyy-mm-dd format | Provide a valid dates format in yyyy-mm-dd format |
| 400 | fromDate not in valid format. Date has to be in yyyy-mm-dd format | Provide a valid dates format in yyyy-mm-dd format |
| 400 | toDate not in valid format. Date has to be in yyyy-mm-dd format | Provide a valid toDate format in yyyy-mm-dd format |
| 404 | Requested user does not exist. | This user is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 404 | Requested resource is not found | This resource is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 403 | Please contact us to have your API key enabled for Income Summary. | You are not enabled for this feature. Please contact Customer Success to have this enabled. |
| 400 | User's accounts contains mixed currencies | User's accounts contains mixed currencies which is causing issues with aggregation. Remove these accounts |
| 500 | Internal server error. Please contact support. | Please contact Customer Success |
GET /users/{userId}/income/{snapshotId}
/users/{userId}/income/{snapshotId}| Status code | Response title/detail | Action |
|---|---|---|
| 401 | Invalid authorization token. | Provide key-value pair {"authorization" : " Bearer YOUR_ACCESS_TOKEN" } inside request header |
| 403 | Token has expired | Get a new access token on /token endpoint |
| 400 | User ID value is not valid | Provide a valid userID |
| 400 | Snapshot ID value is not valid | Provide a valid snapshotId in URL |
| 400 | Accept type application/json is not supported on requested endpoint. | provide a valid accept type |
| 403 | Access to this resource is forbidden | Incorrect/missing scope set for the token you are using, You likely need to supply scope=SERVER_ACCESS. Make sure when you provide scope you are setting this in the body and not as a request header. |
| 401 | Unauthorized access | Ensure you the token you're using is valid for use with the resources in the URL |
| 400 | Snapshot ID value is not supplied | Missing snapshotId, please provide in URL |
| 404 | Requested user does not exist. | This user is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 404 | Requested resource is not found | This resource is unable to be found as the user does not have any accounts. |
| 403 | Please contact us to have your API key enabled for Income Summary. | You are not enabled for this feature. Please contact Customer Success to have this enabled. |
| 500 | Internal server error. Please contact support. | Please contact Customer Success |
POST /users/{userId}/expenses
/users/{userId}/expenses| Status code | Response title/detail | Action |
|---|---|---|
| 401 | Invalid authorization token. | Provide key-value pair {"authorization" : " Bearer YOUR_ACCESS_TOKEN" } inside request header |
| 403 | Token has expired | Get a new access token on /token endpoint |
| 400 | User ID value is not valid | Provide a valid userID |
| 400 | Accept type is not supported | Provide a valid accept type |
| 403 | Access to this resource is forbidden | Incorrect/missing scope set for the token you are using, You likely need to supply scope=SERVER_ACCESS. Make sure when you provide scope you are setting this in the body and not as a request header. |
| 401 | Unauthorized access | Ensure you the token you're using is valid for use with the resources in the URL |
| 400 | Dates not in valid format. Date has to be in yyyy-mm-dd format | Provide a valid dates format in yyyy-mm-dd format |
| 400 | fromDate not in valid format. Date has to be in yyyy-mm-dd format | Provide a valid dates format in yyyy-mm-dd format |
| 400 | toDate not in valid format. Date has to be in yyyy-mm-dd format | Provide a valid toDate format in yyyy-mm-dd format |
| 404 | Requested resource is not found | This resource is unable to be found as the user does not have any accounts. |
| 403 | Please contact us to have your API key enabled for Income Summary. | You are not enabled for this feature. Please contact Customer Success to have this enabled. |
| 400 | User's accounts contains mixed currencies | User's accounts contains mixed currencies which is causing issues with aggregation. Remove these accounts |
| 500 | Internal server error. Please contact support. | Please contact Customer Success |
GET users/{userId}/expenses/{snapshotId}
users/{userId}/expenses/{snapshotId}| Status code | Response title/detail | Action |
|---|---|---|
| 401 | Invalid authorization token. | Provide key-value pair {"authorization" : " Bearer YOUR_ACCESS_TOKEN" } inside request header |
| 403 | Token has expired | Get a new access token on /token endpoint |
| 400 | User ID value is not valid | Provide a valid userID |
| 400 | Snapshot ID value is not valid | Provide a valid snapshotId in URL |
| 400 | Accept type application/json is not supported on requested endpoint. | Provide a valid accept header |
| 403 | Access to this resource is forbidden | Incorrect/missing scope set for the token you are using, You likely need to supply scope=SERVER_ACCESS. Make sure when you provide scope you are setting this in the body and not as a request header. |
| 401 | Unauthorized access | Ensure you the token you're using is valid for use with the resources in the URL |
| 400 | Snapshot ID value is not supplied | Missing snapshotId, please provide in URL |
| 500 | Internal server error. Please contact support. | Please contact Customer Success |
| 404 | Requested user does not exist. | This user is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 400 | Invalid expenses snapshot ID provided | Invalid snapshotId, please check the value you are providing |
| 404 | User doesn't have any accounts | User does not have any accounts connected |
| 403 | Please contact us to have your API key enabled for Income Summary. | You are not enabled for this feature. Please contact Customer Success to have this enabled. |
POST users/{userId}/statements
users/{userId}/statements| Status code | Response title/detail | Action |
|---|---|---|
| 401 | Invalid authorization token. | Provide key-value pair {"authorization" : " Bearer YOUR_ACCESS_TOKEN" } inside request header |
| 403 | Token has expired | Get a new access token on /token endpoint |
| 400 | User ID value is not valid | Provide a valid userID |
| 400 | Statement is not valid | Check you are providing either a valid statement file or an institutionId. |
| 413 | Request Too Long | The statement you have provided is too large, try with something smaller. |
| 400 | Institution AU00000 is not supported on this endpoint | Choose correct/compatible institution for statement upload |
| 400 | Accept type application/json is not supported on requested endpoint. | Provide a valid accept header |
| 403 | Access to this resource is forbidden | Incorrect/missing scope set for the token you are using, You likely need to supply scope=SERVER_ACCESS. Make sure when you provide scope you are setting this in the body and not as a request header. |
| 401 | Unauthorized access | Ensure you the token you're using is valid for use with the resources in the URL |
| 404 | Requested user does not exist. | This user is unable to be found. It may have been deleted or you may be using the incorrect API as resources are restricted to their designated applications. |
| 403 | Please contact us to have your API key enabled for Income Summary. | You are not enabled for this feature. Please contact Customer Success to have this enabled. |
| 400 | User's accounts contains mixed currencies | User's accounts contains mixed currencies which is causing issues with aggregation. Remove these accounts |
| 500 | Internal server error. Please contact support. | Please contact Customer Success |
| 503 | Service is currently unavailable. Please try again later. | Please try again. If problem persists get in touch with Customer Success. |
Updated about 2 years ago