This call will allow the user to specify a file and location to upload the file. This call will allow the user to make a POST call to upload a file into Validate Data Manager or get an estimate of its success rate. This means that you can check that the data is correct and you have selected the correct options before uploading the file.
To get an estimate of the validation rate you just set the flag viewEstimateonly to Y then this call will only estimate the conversion rate of the file. The estimated validation rate will be based on the first 5000 records only, this will be basic format checking only with no modulus or data checking. As the estimate is only based on the first 5,000 records in the file, if you upload a file with 100,000 records then the final validation rate may differ from this value significantly. This has been done to limit the time the user has to wait for a response and will prevent any call time-outs due to large files begin checked. If you perform an estimate then please discard the fileToken, a new fileToken will be given on file upload along with the estimate. Once the user has set a file to upload the file will process and the users subscription will be deducted, the estimate only does not deduct anything from the users subscription.
To upload the data for validation set the viewEstimateonly flag to N. The maximum file size will be 100,000 records. The fileToken will have no expiry and will be linked to a company so users from another company are not able to download this file. The fileToken will uniquely identify this file and is not only linked to the file to allow you to download and manage the file but is also linked to your company account for additional security. This will prevent unauthorised access to your data from other users of the system.
The storeFile flag if set to Y will mean the data is stored permanently in the system or until the user deletes it. If the flag is set to N then the user can delete the file at any time and if the file is not deleted then the system will store the data for 2 months if it has not downloaded if it has been downloaded then the system will keep the file for 1 month until it is automatically removed.
Endpoint
https://validate.bankersalmanac.com/vdmapi/service/1.0
METHOD
POST in “application/x-www-form-urlencoded” format
Upload
The upload fields and flags are below
| Field Name | Allowed Characters | Description | Mandatory Field | Default Value | |
| file | Alphanumeric | File and location | Mandatory | ||
| token | Alphanumeric | User authentication token from the user authentication call | Mandatory | ||
| fileFieldCountryCode | numeric | Column number that the country code is in | Mandatory | 1 | |
| fileFieldNationalId | numeric | Column number that the national id is in | Mandatory | 2 | |
| fileFieldAccountNumber | numeric | Column number that the account number is in | Mandatory | 3 | |
| fileFieldIbanBic | numeric | Column number that the IBAN BIC is in | Mandatory | 4 | |
| fileFieldRef | numeric | Column number that the field ref is in | Mandatory | 5 | |
| group | numeric | Column number that the group ref is in | Mandatory | 6 | |
| dataStoreFlag | Y or N | Do you wish to store these details for regular checking in check and fix | Mandatory | N | |
| emailOncompletition | Y or N | Do you wish to be emailed on completion | Mandatory | N | |
| emailOnCompletionFlag | Alphanumeric @ and . in email format | Do you wish the email to go to an address other than the address for the registered user. If you do then enter the email you wish the file completion notification to go to. | Mandatory | ||
| bankNmandaddress | Y or N | Do you wish the bank name and address to be added to the file | Mandatory | N | |
| viewEstimateOnlyFlag | Y or N | Do you wish to view the estimate and confirm before processing. If Y you will only get an estimate and the file will not process. If N then the file will process and the user will still receive an estimate but the user will not get the chance to not process the file and their subscription will be deducted | Mandatory | N | |
| bic8Flag | Y or N | Do you wish head office BICs (BIC which end in XXX as the last 3 digits of a BIC11) as BIC8. | Mandatory | N | |
| outputType | XML XLSX CSV |
What file type do you wish the file to be downloaded as | Mandatory | The upload format | |
| payBranchType | I P H B R |
This allows you to choose what the output BIC is, the options are: I – IBAN BIC P – Payment BIC H – Head Office BIC B – Branch BIC R – Routing BIC |
Mandatory | ||
| basicValidationFlag | Y or N | Do you wish to use basic validation only which means that you just get a Pass or Fail option but it does not perform full checks. It just checks the IBAN format and does not check data or any non-IBAN format or domestic rules. This is not a recommended option. | Mandatory | N |
Response
The response will be have the following fields.
| Field Name | Allowed Characters | Description | Mandatory Field | Default Value |
| status | Alpha | Status of the file | Mandatory | |
| comment | Alphanumeric | This description of the error message | Optional | |
| date | dd/mm/yy | Date the file was uploaded | Optional | |
| fileToken | Alphanumeric | Unique token, this will allow you to perform other actions against this file. | Optional | |
| estimatePass | numeric | Estimated number of records that will pass | Optional | |
| estimateCaution | numeric | Estimated number of records that will caution | Optional | |
| estimateFail | numeric | Estimated number of records that will fail | Optional |
Error Status
The file status can be
| Status | Comment |
| Failed | Check file format |
| Failed | System error (99sys) |
| Failed | Check line XXX |
| Pass | File processing |
| Pass | Estimate given |
If the file fails then only the fields Status and Comment will be complete you will not receive a file estimate.