Bulk Results Request API Specification
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.
Document History
| Version | Date | Description |
|---|---|---|
| 1.0 | 15 Jan 2025 | Original Digital Version. Aligned with PDF V1.0 |
#Request
Request headers
- Name
X-Request-Id- Type
- String
- Tag(s)
- Mandatory
- Description
A RFC4122 UUID used as a correlation id.
- Name
Content-Type- Type
- application/json
- Tag(s)
- Mandatory
- Description
Content type and encoding of the request.
- Name
Authorization- Type
- Bearer
- Tag(s)
- Mandatory
- Description
Oauth 2.0 bearer token.
- Name
Accept-Language- Type
- String
- Tag(s)
- Optional
- Description
Can be provided by the Requesting PSP to be used as language in the 'nameSuggestion' response field (when data is available in given language).
- Format: ISO 639.
Example of Request headers
| Header name | Example |
|---|---|
| X-Request-Id | 123e4567-e89b-12d3-a456-42661417400 |
| Content-Type | application/json;charset=utf-8 |
| Authorization | Bearer <your bearer token> |
| Accept-Language | EN |
Request body
This endpoint does not require a request body. The taskId is passed as a path parameter.
- Name
taskId- Type
- String
- Tag(s)
- Mandatory
- Description
The Unique ID used for retrieving the result in a separate request. This is returned in the response when submitting the bulk request.
Response
The response is an NDJSON file.
- Successful response (HTTP 200 - described below)
- Error response (HTTPXXX - described in Errors)
Response Headers
- Name
X-Request-ID- Type
- String
- Tag(s)
- Mandatory
- Description
The Requesting PSP’s reference number of the VOP Request. Value sent in the request, mapped directly to the response (not generated again).
- Name
Content-Type- Type
- application/x-ndjson
- Tag(s)
- Mandatory
- Description
Content type and encoding of the request.
- Name
Content-Disposition- Type
- {taskIs}.ndjson
- Tag(s)
- Mandatory
- Description
Attachment where the filename is the taskId.
Response body
- Name
uetr- Type
- String
- Tag(s)
- Mandatory
- Description
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.
- Name
partyNameMatch- Type
- Enum
- Tag(s)
- Conditional
- Description
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.
- Name
partyIdMatch- Type
- Enum
- Tag(s)
- Conditional
- Description
Describes the result of the IBAN-ID Check. Future ISO code expected.
- MTCH (Match): The ID matches a record in the system.
- NMTC (No Match): The ID does not match any records.
- NOAP (Not Applicable): Identification code not supported/known by the Responding PSP.
Only applicable if ‘identification’ object has been added in the request.
- Name
matchedName- Type
- String
- Tag(s)
- Conditional
- Description
Contains the corrected name of the account holder. Always returned in case of a Close Match. It’s also returned in case of a No Match and the account type is ‘ORG', if supported by the responding PSP.
- Name
additionalPartyInformation- Type
- Object
- Tag(s)
- Add on Feature
- Description
Request
GET /vopgateway/v1/bulk/12930484-129284501-ecernb
Response
{"uetr": "2f01983c-a558-445c-8728-dba547d2ff8b", "partyNameMatch": "MTCH"}