This chapter provides detailed information on how to retrieve the results of a bulk request. The results file can only be accessed after the status of the bulk request has been updated to 'PROCESSED'. The response to this request is returned in NDJSON format, containing the finalized data for the completed bulk operation. You can read about the error status and codes here.
Updated Language in requeste header from ISO639 to ISO639-1
2.0
20 Mar 2025
Format changes, aligned with VoP single check API. Refer to the detailed changes here.
2.1
16 Apr 2025
Updated 'fraudRiskIndicator' type from 'Object' to 'Array of Objects' and added the following new headers: X-End-User, X-Software-Supplier and X-Channel
2.2
16 Jun 2025
Updated description for detailedMatchResult field.
The media type the client can process in the response. This is set to application/x-ndjson.
Example: applicaton/x-ndjson
Accept-LanguageStringOptional
Can be provided by the Requesting PSP to be used as language in the 'nameSuggestion' response field (when data is available in the given language).
Format: ISO 639-1.
X-End-UserStringOptional
This field is used to identify the endpoint user, customer, department or system.
In case the customer identifies more departments/end users within the same company which will use the API. Every department could be identified with a unique X-End-User.
In case the customer is reselling the API as a partner. Every new customer of the partner should be identified with a unique X-End-User.
Value of the header will have no effect on the end result.
Format: Max. 50 characters.
Format: ^[a-zA-Z0-9\-]{3,50}
X-Software-SupplierStringOptional
It is used in case there is an external software supplier involved. This header must be provided if you are using a third party software supplier. In case the SurePay customer uses more than one software supplier then all of them can be provided in the header.
In case the customer wants to distinguish traffic based on their channel. A channel can be set by the customer at any value and the value will show up in reporting.
The Unique End-to-End Transaction Reference (UETR) is an RFC4122 UUID used as a record-level correlation ID to uniquely track and trace individual transactions throughout the process.
partyNameMatchEnumConditional
Describes the result of the IBAN-Name Check.
MTCH (Match): The name matches exactly with a record in the system – a confirmed match.
CMTC (Close Match): The name closely matches a record but may have slight differences, like spelling variations – a partial or approximate match.
NMTC (No Match): The name doesn't match any records in the system – no match found.
NOAP (Not Applicable): Verification check not possible, validation check is not applicable.
Only applicable when name field has been added in the request.
partyIdMatchEnumConditional
Describes the result of the IBAN-ID Check.
MTCH (Match): The ID matches a record in the system - a confirmed match.
NMTC (No Match): The ID does not match any records - no match found.
NOAP (Not Applicable): The ID code is not supported or known by the Responding PSP - Verification check not possible, validation check is not applicable.
Only applicable if identification object has been added in the request.
matchedNameStringConditional
Returns the corrected name of the account holder.
Always returned in case of a Close Match (CMTC).
It's also returned in case of a No Match (NMTC) and the account type is 'ORG', if supported by the Responding PSP.
additionalPartyInformationObjectConditional
This is additional information on top of the VoP Scheme. Its availability is dependent on the responding PSP and whether the SurePay Plus subscription and Add-ons (like FRI) are enabled.
advancedInfoObjectConditional
This is advanced information on top of the VoP Scheme if subscribed to SurePay Plus. Its availability is dependent on the responding PSP.
accountHolderTypeEnumConditional
Describes the type of the account holder.
Possible Values:
NP: Natual Person
ORG: Organisation
UNKNOWN: Not provided by the Responding PSP.
accountStatusEnumConditional
The status of the account.
Possible Values:
ACTIVE: a valid account and supported for checks.
INACTIVE: a valid account marked by the Responding PSP as inactive.
UNKNOWN: for an account that its status has been not known/provided by the Responding PSP.
detailedMatchResultEnumConditional
Additional information in case the matching result was not a match.
Possible Values:
NAME_TOO_SHORT: the user only inputs a first name instead of a first name and surname.
BANK_NOT_FOUND: the Responding PSP is not yet part of the VOP Scheme.
OPTED_OUT: the account holder has opted out.
ID_NOT_SUPPORTED: the provided partyIdentification type is not supported by the Responding PSP.
NOT_FOUND: the account number was not found in the Responding PSP's records.
townNameStringConditional
The residence town/city of the account holder.
fraudRiskIndicatorArray of ObjectsConditional
The fraud risk indicator object as a Add-on on top of the VoP Scheme.
switchingInformationObjectConditional
The switch check info object as a Add-on on top of the VoP Scheme. Only returned when the account has switched to another bank.