Get the virtual entities by given virtual entity Id
get
/service/virtualentities/{virtualEntityId}
This endpoint is used to get the virtual entities identified by given virtual Entity Id.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
virtualEntityId: string
Key of the virtualentities maintenance
Query Parameters
-
version(optional): string
version of the virtualentities maintenance"
Response
Supported Media Types
- application/json
- text/csv
- application/xml
200 Response
Successful operation.
Nested Schema : EntityMasterServiceDTO-allOf[0]
Type:
Show Source
object-
amlCustomerGroup(optional):
string
Maximum Length:
105Maintain Aml Customer Group here -
amlRequired(optional):
string
Maximum Length:
1Specify AML Required Status here -
approverRemarks(optional):
string
Remarks made by Approver
-
authStatus(optional):
string
Authorization Status of Virtual Account
-
checkerDateStamp(optional):
string
Date and Time when some action on Virtual Account is authorized
-
checkerId(optional):
string
Checker ID of Virtual Account
-
correspondenceAddressLine1:
string
Maximum Length:
105Specify Correspondence Address Line Number-1 here -
correspondenceAddressLine2(optional):
string
Maximum Length:
105Specify Correspondence Address Line Number-2 here -
correspondenceAddressLine3(optional):
string
Maximum Length:
105Specify Correspondence Address Line Number-3 here -
correspondenceAddressLine4(optional):
string
Maximum Length:
105Specify Correspondence Address Line Number-4 here -
correspondenceCountry:
string
Maximum Length:
3Specify Correspondence Country Code here -
correspondencePincode(optional):
string
Specify Correspondence PIN Code here
-
creationDate(optional):
string
Read Only:
trueDate of account creation -
defaultEntity(optional):
string
Maximum Length:
1Specify whether the entity is being generated default from account facility domain -
doerRemarks(optional):
string
Remarks made by Maker
-
EntityCorporateDetailsServiceDTO(optional):
object EntityCorporateDetailsServiceDTO
-
EntityIndividualDetailsServiceDTO(optional):
object EntityIndividualDetailsServiceDTO
-
entityType:
string
Maximum Length:
1Specify Entity Type here -
fatcaResponsible(optional):
string
Maximum Length:
1Specify Fatca Responsible here -
identificationNo(optional):
string
Maximum Length:
100Specify Identification Number here -
identificationType(optional):
string
Maximum Length:
1Specify Identification Type here -
kycReference(optional):
string
Maximum Length:
100Specify KYC Reference here -
kycStatus(optional):
string
Maximum Length:
1Specify KYC Status here -
lastKycDate(optional):
string
Specify last Date for KYC here
-
makerDateStamp(optional):
string
Date and Time when Virtual Account is created or modified or closed or reopened
-
makerId(optional):
string
Maker ID of Virtual Account
-
modNo(optional):
integer
Version number of Virtual Account
-
onceAuth(optional):
string
Flag that indicated if Virtual Account is authorized once or not
-
operationType(optional):
string
operation type
-
realCustomerNo:
string
Specify Real Customer Number here
-
recordStatus(optional):
string
Record Status of Virtual Account
-
registeredAddressLine1:
string
Maximum Length:
105Specify Address Line Number-1 here -
registeredAddressLine2(optional):
string
Maximum Length:
105Specify Address Line Number-2 here -
registeredAddressLine3(optional):
string
Maximum Length:
105Specify Address Line Number-3 here -
registeredAddressLine4(optional):
string
Maximum Length:
105Specify Address Line Number-4 here -
registeredCountry:
string
Maximum Length:
3Specify Registered Country Code here -
registeredPincode(optional):
string
Specify Registered PIN Code here
-
resourceId(optional):
string
resource id
-
resourceName(optional):
string
resource name
-
sanctionCheckRequired(optional):
string
Maximum Length:
1Specify Sanction check required here -
StatementPreferencesServiceDTO(optional):
object StatementPreferencesServiceDTO
-
StructuredAddressServiceDTO(optional):
object StructuredAddressServiceDTO
-
taxIdentificationNo(optional):
string
Maximum Length:
100Specify Tax Identification Number here -
virtualEntityId:
string
Minimum Length:
1Maximum Length:12Specify Virtual Entity Identification Number here -
virtualEntityName:
string
Minimum Length:
1Maximum Length:105Pattern:([a-zA-Z0-9\|\.\-\&\(\)\/\s]+)?Specify Virtual Entity Type here
Nested Schema : EntityCorporateDetailsServiceDTO
Type:
Show Source
object-
bicCode(optional):
string
Specify corporate bic code here
-
corporateEntityType:
string
Maximum Length:
1Specify corporate EntityType here -
countryOfIncorporation(optional):
string
Maximum Length:
105Specify Country of Incorporation here -
dateOfIncorporation(optional):
string
Specify Date of Incorporation here
-
email(optional):
string
Maximum Length:
255Pattern:(^$|[A-Za-z0-9+_.-]+@\w+?\x2E.+)Specify Email Id here -
mobileNo(optional):
string
Maximum Length:
10Specify Mobile Number here -
mobileNoIsd(optional):
string
Maximum Length:
4Pattern:^[0-9]*$Specify Mobile Number Country Code here -
preferredMode(optional):
string
Maximum Length:
1Specify Preferred Mode here -
uniqueId(optional):
string
Maximum Length:
35Specify Unique Identification Number here -
virtualEntityId:
string
Specify Virtual Identification Number here
-
workPhoneIsd1(optional):
string
Maximum Length:
4Specify ISD Code for First Working Phone Number here -
workPhoneIsd2(optional):
string
Maximum Length:
4Pattern:^[0-9]*$Specify ISD Code for Second Working Phone Number here -
workPhoneNo1(optional):
string
Maximum Length:
10Pattern:^[0-9]*$Specify First Working Phone Number here -
workPhoneNo2(optional):
string
Maximum Length:
10Pattern:^[0-9]*$Specify Second Working Phone Number here
Nested Schema : EntityIndividualDetailsServiceDTO
Type:
Show Source
object-
dateOfBirth(optional):
string
Specify Date Of Birth of Customer here
-
email(optional):
string
Maximum Length:
255Pattern:(^$|[A-Za-z0-9+_.-]+@\w+?\x2E.+)Specify Email Id of Customer here -
firstName:
string
Maximum Length:
105Specify First Name of Customer here -
gender(optional):
string
Maximum Length:
1Specify Gender of Customer here -
homePhoneIsd(optional):
string
Maximum Length:
4Pattern:^[0-9]*$Specify Home International Subscriber Dailing of Customer here -
homePhoneNo(optional):
string
Maximum Length:
10Pattern:^[0-9]*$Specify Home Phone/Mobile Number of Customer here -
lastName:
string
Maximum Length:
105Specify Last Name of Customer here -
middleName(optional):
string
Maximum Length:
105Specify Middle Name of Customer here -
mobileNo(optional):
string
Maximum Length:
10Specify Mobile Number here -
mobileNoIsd(optional):
string
Maximum Length:
4Pattern:^[0-9]*$Specify Mobile Number Country Code here -
nationalId(optional):
string
Maximum Length:
35Specify Nationality Identification Number of Customer here -
nationality(optional):
string
Maximum Length:
3Specify Nationality of Customer here -
preferredMode(optional):
string
Maximum Length:
1Specify Preferred Mode here -
virtualEntityId:
string
Specify Virtual Entity Identification Number here
-
workPhoneIsd(optional):
string
Maximum Length:
4Pattern:^[0-9]*$Specify Working International Subscriber Dailing of Customer here -
workPhoneNo(optional):
string
Maximum Length:
10Pattern:^[0-9]*$Specify Working Phone/Mobile Number of Customer here
Nested Schema : StructuredAddressServiceDTO
Type:
Show Source
object-
buildingName(optional):
string
Maximum Length:
35building Name -
buildingNumber(optional):
string
Maximum Length:
16Building Number -
countrySubDivision(optional):
string
Maximum Length:
35Country Sub Division -
department(optional):
string
Maximum Length:
70Department -
districtName(optional):
string
Maximum Length:
35District name -
floor(optional):
string
Maximum Length:
70Floor -
operationType(optional):
string
operation type
-
postbox(optional):
string
Maximum Length:
16postbox -
postcode:
string
Maximum Length:
16postcode -
resourceId(optional):
string
resource id
-
resourceName(optional):
string
resource name
-
room(optional):
string
Maximum Length:
70Room -
streetName(optional):
string
Maximum Length:
70Street Name -
strrCountry:
string
Maximum Length:
2country -
subDepartment(optional):
string
Maximum Length:
70Sub Department -
townLocationName(optional):
string
Maximum Length:
35Town Location Name -
townName:
string
Maximum Length:
35Town Name -
virtualEntityId:
string
Specify Virtual Entity Identification Number here
Nested Schema : StatementPreferencesServiceDTO-allOf[0]
Type:
Show Source
object-
camt052GenTime(optional):
string
Comma separated time for generating CAMT.052
-
camt052RepTxnSince(optional):
string
Report transactions since for CAMT.052
-
displayIban(optional):
string
Pattern:
[Y,N]Display Virtual IBAN in Swift Messages -
dueOn(optional):
number
Pattern:
([0-9]+)?Statement due date -
frequency(optional):
string
Pattern:
[D,W,M,Q,H,Y]Frequency of statement - Daily/Weekly/Monthly/Quarterly/half yearly/Yearly -
genCamt052OnMovement(optional):
string
Pattern:
[Y,N]Generate CAMT.052 on movement -
generateCamt052(optional):
string
Pattern:
[Y,N]Generate CAMT.052 -
generateCamt053(optional):
string
Pattern:
[Y,N]Generate CAMT.053 during EOD -
generateMt940(optional):
string
Pattern:
[Y,N]Generate MT940 during EOD -
generateMt942(optional):
string
Pattern:
[Y,N]Generate MT942 -
generateMt950(optional):
string
Pattern:
[Y,N]Generate MT950 during EOD -
generatePdf(optional):
string
Pattern:
[Y,N]Generate PDF statement during EOD -
genMt942OnMovement(optional):
string
Pattern:
[Y,N]Generate MT942 on movement -
lastStmntGenDate(optional):
string
Last statement generation date
-
mt942GenTime(optional):
string
Comma separated time for generating MT942
-
mt942RepTxnSince(optional):
string
Report transactions since for MT942
-
resourceId(optional):
string
resource id
-
resourceName(optional):
string
resource name
-
statementType(optional):
string
Pattern:
[A,C]Type of the statement - Consolidated/Account level -
virtualEntityId(optional):
string
Specify Virtual Identification Number here
400 Response
Bad request error, the server is unable to process the request.
401 Response
Unauthorized request error, invalid credentials.
403 Response
Request denied, no permission to access the request.
500 Response
Internal server error.