The API allows us to upload a list of payee details in a file (.xls or .xlsx or .csv) and name verification check will be done against each row provided.
Accounts details have to be uploaded using this template to do name verification or JSON request payload.
The data in the file will undergo a validation check prior to name verification check.
The files with no validation failures will be processed further for confirmation of payee details.
If the file has validation failures, it will not be processed.
In case the request body is invalid, the error will be reported in the API response.
Unique Id sent by the requester for every request in UUID4 format for cross reference purpose.
Request Body for multipart/form-data
Attribute
Type
Condition
Description
Content type
File
.xls or .xlsx or .csv
Mandatory
The payee details have to be uploaded using this template
Multipart/form-data
(OR)
Request Body Application/JSON
Attribute
Type
Condition
Description
idType
String
Mandatory
Identification details of the account verification request is collected in identification-type/identification-value pair format. This parameter is represents the identification type. Example: ICQX, ICS, VAT
idValue
String
Mandatory
Identification details of the account verification request is collected in identification-type/identification-value pair format. This parameter is represents the identification type's value
types
String
Mandatory
Account verifications can be performed based on various parameters. Describes whether the verification is done based on the account status or name or identifier. The types of check available on an account depends on the capability of the account verification service responder
idScheme
String
Mandatory
Specifies the account identification scheme code
id
String
Mandatory
A number or alphanumeric string that is used in conjunction with ID scheme
secoundaryId
String
Optional
Secondary reference for the account
holdingEntity
Object
Mandatory
The entity that holds the account. Typically, a bank, building society or an account holding payment services provider. Uses a entity-type/entity-type-value pair format to identify the entity
identities
Object
Mandatory
Unique identifiers of an entity (typically an organisation - but, can be a person as well) represented as identification-type/identification-type-value pair format.
Response Headers
Attribute
Type
Condition
Description
transaction-XRef-Id
UUID
Mandatory
Unique Id sent by the requester for every request in UUID4 format for cross reference purpose
retry-After
Integer
Optional/Mandatory in some error cases
Seconds after which a new request can be sent
Response Body
200 OK (Success Response)
Attribute
Type
Condition
Description
id
String
Mandatory
A unique id is generated for every batch uploaded
message
String
Mandatory
This message will let us know whether the upload of batch is successful
status
String
Mandatory
Status to show the request status "PENDING OR COMPLETE"
400 (Error Response)
Attribute
Type
Condition
Description
errorCode
enum
Mandatory
Low level textual error code, example INVALID_FIELD
message
String
Mandatory
A description of the error that occurred.
path
String
Optional
Recommended but optional reference to the JSON Path of the field with error, e.g., data.verification.type
url
String
Optional
URL to help remediate the problem, or provide more information, or to API Reference, or help etc
# Success Response for files with no validation failuresHTTP/1.1 200 Verification is pending
Content-Type: application/json
{"data":{"bulkResult":{"id":"e1936e71-3402-4545-95a3-16e7329725b0",
"xRefId":"93bac548d2de4546b106",
"message":"Verification is pending.",
"status":"PENDING"},
"result":[]}}
# Success Response for files with no validation failuresHTTP/1.1 200 Verification is pending
Content-Type: application/json
{"data":{"bulkResult":{"id":"e1936e71-3402-4545-95a3-16e7329725b0",
"xRefId":"93bac548d2de4546b106",
"message":"Verification is pending.",
"status":"PENDING"},
"result":[]}}
VOP