Overview
This article explains how to investigate a failed file validation when the upload happens via API. Validation errors are explained clearly for user uploads, but it can be harder to identify the source of a validation error for API uploads.
By following the steps outlined below, users can locate the specific properties causing the failure, allowing them to correct the data and successfully re-upload the file.
For a general overview of the validation process, refer to the following resource on Positions File Validation.
What This Means
When an API upload fails validation, the system sends an email notification to the person who authorised the upload. This notification is similar to the error message displayed when an upload fails validation via the UI. Conversely, successful uploads are clearly visible when navigating to Admin > Previous Uploads.
Why It Happens
Validation feedback is contained within the UI, rather than provided in the API response, to maintain strict security around sensitive data. Because validation errors could contain position-level information, the platform restricts visibility to ensure only users with appropriate permissions can view the details.
How to Resolve
To investigate the error and view the full details of the properties that caused the failure:
Log in to the environment where the file has been uploaded.
Go to Admin and settings > Previous Uploads
Find the upload that failed. Failed uploads show a ValidationFailed status.
Click the kebab menu icon at the far right, then select Validate or Download Validation to see what is causing the validation errors.
If Validate was chosen, the next screen will show why validation failed. Using the Download Validation option will generate a TXT file listing the issues to help you identify what caused the failure.
The next screen/download shows why the file failed validation and helps you identify what to change. It gives the full details of the properties that caused the failure, just as it would if you'd uploaded the file via the UI.
Frequently Asked Questions
Q. I tried uploading a file but got the following error: "There was a problem validating this data file. Support has been notified, and we will let you know when the issue has been resolved." Now what?
A. While this is a blanket error, one of the reasons that could be causing the file upload to fail and receive this error may be the file size. The maximum file size is 11.4 MB when uploading via the UI. If your file exceeds the specified size, compress it and upload it as a ZIP file. On the Positions Upload screen, you can upload XML and ZIP files (CSV files are not allowed). The API is not limited to this file size restriction.
Q. Why can't this information be provided in the API response?
A. The simple answer is security around sensitive data. We take security extremely seriously. As the validation errors could contain position-level information, we contain the API validation feedback in your environment to ensure that only people with the appropriate permissions can see it.
Q. I received the following validation error when uploading a Portfolio file: "(invalid - The portfolio has an inception date beyond nav date)." What should I do?
A. This error ("inception date beyond nav date") means you are not providing a Snapshot Date in your positions file, and in the positions file (which can be downloaded from the Previous Uploads screen), will most likely show on line "1" that you have "Null" for the date. Please provide a NAV Date, and this should resolve the issue.
Q. Can amendments be made to how files are processed upon discovering a validation error?
A. The way XML validation behaves upon discovering a file error is not something we can amend because it uses a standard XML parser; however, please contact our Support team if you have any questions on validation failures.