Skip to main content

VA reference data

GET
Authentication

Virtual Account APIs use the same access token as the rest of the platform. Obtain it from the Authentication API and send it on every VA call:

Authorization: Bearer <access_token>

Base URLs for each environment are listed under API environments.

note

What this covers: Every coded field used across this doc (occupationCode, legalStatusCode, natureOfBusinessCode, businessRelationshipCode, customerTypeCode, residenceStatusCode, idTypeCode) is backed by its own lookup endpoint. Call these to get the full list of valid codes and their display names — don't hardcode a single example value from elsewhere in this doc.

Individual Customer Lookups​

FieldEndpoint (GET)List Key
occupationCode/ewallet/api/v1/customerOccupationType/getByCustomerTypeCode/100001customerOccupationTypeList
transactionVolumeCode/ewallet/api/v1/businessTxnVolume/getByCustomerTypeCode/100001businessTxnVolumeList
idTypeCode/ewallet/api/v1/customerDocumentType/getByCustomerTypeCode/100001customerDocumentTypeList

Business Customer Lookups​

FieldEndpoint (GET)List Key
legalStatusCode/ewallet/api/v1/customerLegalStatus/getByCustomerTypeCode/100002customerLegalStatusList
natureOfBusinessCode/ewallet/api/v1/natureOfBusiness/getByCustomerTypeCode/100002natureOfBusinessList
businessRelationshipCode/ewallet/api/v1/purposeOfOpeningBusiness/getByCustomerTypeCode/100002purposeOfOpeningBusinessList
transactionVolumeCode/ewallet/api/v1/businessTxnVolume/getByCustomerTypeCode/100002businessTxnVolumeList

Owner (UBO) Lookups​

FieldEndpoint (GET)List Key
customerTypeCode/ewallet/api/v1/customerType/allcustomerTypeList
residenceStatusCode/ewallet/api/v1/residenceStatus/customerTypeCode/100001residenceStatusList
idTypeCode/ewallet/api/v1/idType/getByCustomerTypeCode/100002idTypeList

Sample Response Shape​

{
"resultCode": "0",
"resultDescription": "Transaction successful",
"customerOccupationTypeList": [
{
"id": 81,
"code": "RHO015",
"customerTypeCode": "100001",
"name": "Consultant",
"status": "Active",
"creationDate": "2025-03-19T17:23:54.415+0530"
}
// ...full list
]
}
warning

One endpoint mislabeled in the source: "Corporate Customer Document Type List" is documented against customerDocumentType/getByCustomerTypeCode/ 100001 (the Individual code) rather than 100002. This looks like a copy-paste in the source material — worth confirming with IT before publishing, rather than assuming it's correct as-is.

Shared master APIs​

Several of the lookups above are the platform's own master APIs, used here in a VA context rather than duplicated: Occupation, Document ID Type, Customer Legal Status, Nature of Business and the rest of the master / reference APIs. Where the VA source lists an endpoint not documented there, use the path shown above.