FI Schema – EPF

FI Schema – Employee Provident Fund (EPF)

EPF
Employee Provident Fund
AccountBasic Profile of the account which should include the Account Owner information, maskedAccNumber and linkedAccRef numbers,
type of account specific to the FI type and any other generic details as might be pertinent for the specified FI type.
AttributesNameTypeUseAnnotation
maskedAccNumberstringrequiredMasked Account No.
linkedAccRefstringrequiredLinked account reference no. for the account
versionfloatrequiredVersion of Schema
typestringrequiredType of Schema (Fixed: "certificates_deposit")
ProfileBasic Profile of the account which should include the Account Owner information, maskedAccNumber and linkedAccRef numbers,
type of account specific to the FI type and any other generic details as might be pertinent for the specified FI type.
Holders
HolderQNameTypeUseAnnotation
namestringrequiredName of primary holder operating the account.
dobdaterequiredDate of birth of primary account holder.
mobileintegerrequiredPrimary mobile number of account holder.
nomineeenum(Registered, Not-Registered)requiredName of nominee associated with the account.
uanstringoptional
landlinestringoptionalLandline no. of the Account Holder
addressstringoptionalAddress of primary holder.
emailstringrequiredEmail ID of primary account holder.
panstringrequiredPAN number of primary account holder.
ckycCompliancebooleanrequiredKYC status whether its completed or pending
SummaryThe value of the account, term of the deposits if relevant and any other data that summarizes the funds in the account.
AttributesQNameTypeUseAnnotation
currentBalancefloatrequiredCurrent available balance in EPF account.
openingDatedaterequiredOpening date of EPF account
establishmentIddaterequiredEstablishement Trust ID under which company providing PF is registered.
establishmentNamestringrequiredEstablishement Trust Name under which company providing PF is registered.
employerBalancefloatrequiredBalance contributed by employer.
employeeBalancefloatrequiredBalance contributed by employee.
totalBalancefloatrequiredNet Balance available in the epf account of investor
TransactionsDetails of all transactions that have been posted in an account.
AttributesQNameTypeUseAnnotation
startDatedaterequiredStart date of investment since when it is applicable
endDatedaterequiredEnd date of investment when tenure get complete
TransactionQNameTypeUseAnnotation
txnIDstringrequiredType of transaction whether debit or credit.
txnDatedaterequiredTransaction date time stamp for particular record when investment taken place.
narrationstringrequiredNararation is additional details in form of decription of remark associated with investment.
typeenum(DEPOSIT,
WITHDRAWAL,
INTEREST,
TRANSFER_IN,
TRANSFER_OUT,
ADJUSTMENT,
OTHERS)
requiredType of transaction - contribution, adjustment, etc.
employeeDepositAmountfloatrequiredAmount of PF deposit by employee
employerDepositAmountfloatrequiredAmount of PF deposit by employer.
employeeWithdrawalAmountfloatrequiredAmount of PF withdrawn by employee.
employerWithdrawalAmountfloatrequiredThe credit card number with some of the numbers masked.
pensionFundAmountfloatrequired.Amount of pension fund available at the time of retirement