Developers / Tools & Resources

Partner

These APIs revolve around customers, their details, and their cash transactions. Some examples are shown below to show how these APIs are used.

Create customer

This returns a customer’s KYC details when an ‘id’ is passed. 

#Sample cURL command
curl -X 'POST' \
'https://zas-dev.zanibal.com/api/v1/partner/customer/create' \
-H 'accept: application/json; charset=UTF-8' \
-H 'Content-Type: application/json' \
-d '{ \
id": 0,
active": true,
name": "string",
label": "string",
description": "string",
groupId": 0,
agentId": 0,
fundManagerId": 0,
partnerRiskLimitId": 0,
ecrmId": 0,
referalCode": "string",
referrer": "string",
referrerInfo": "string",
clearingHouseNo": "string",
prefix": "string",
salutation": "string",
suffix": "string",
cashAcct": "string",
cashAcctBalance": "string",
portfolioTypeName": "string",
employerName": "string",
employerAddress": "string",
title": "string",
firstName": "string",
middleName": "string",
lastName": "string",
cellPhone": "string",
homePhone": "string",
otherPhone": "string",
officePhone": "string",
fax": "string",
emailAddress1": "string",
emailAddress2": "string",
birthDate": "2022-05-31T15:48:32.485Z",
nationality": "string",
incCountry": "string",
sex": "string",
motherMaidenName": "string",
bvnCode": "string",
ninCode": "string",
nationalID": "string",
identifier": "string",
identifierType": "string",
identifierExpDate": "2022-05-31T15:48:32.485Z",
utilityBillExpDate": "2022-05-31T15:48:32.485Z",
primaryAddress1": "string",
primaryAddress2": "string",
primaryCity": "string",
primaryPostCode": "string",
primaryState": "string",
primaryCountry": "string",
secondaryAddress1": "string",
secondaryAddress2": "string",
secondaryCity": "string",
secondaryPostCode": "string",
secondaryState": "string",
secondaryCountry": "string",
title_2": "string",
firstName_2": "string",
middleName_2": "string",
lastName_2": "string",
cellPhone_2": "string",
fax_2": "string",
emailAddress1_2": "string",
birthDate_2": "2022-05-31T15:48:32.485Z",
nationality_2": "string",
sex_2": "string",
motherMaidenName_2": "string",
identifier_2": "string",
identifierType_2": "string",
profession_2": "string",
primaryAddress1_2": "string",
primaryCity_2": "string",
primaryPostCode_2": "string",
primaryState_2": "string",
primaryCountry_2": "string",
secondaryAddress1_2": "string",
secondaryCity_2": "string",
secondaryPostCode_2": "string",
secondaryState_2": "string",
secondaryCountry_2": "string",
localGovt": "string",
valuationCurrency": "string",
religion": "string",
howDidYouHearAboutUs": "string",
postNominal": "string",
ethnicity": "string",
maritalStatus": "string",
portalUserName": "string",
portalPassword": "string",
portalPasswordToken": "string",
allowDebitBalance": true,
grantPortalAccess": true,
lastLoginIPAddress": "string",
lastLoginDttm": "2022-05-31T15:48:32.485Z",
secretQuestion": "string",
secretAnswer": "string",
forcePasswordReset": true,
passwordResetToken": "string",
alertsEmail": "string",
profession": "string",
salesRepName": "string",
customerGroupName": "string",
customerGroupLabel": "string",
businessOfficeName": "string",
customerType": "string",
partnerType": "string",
finInstID": "string",
nexofKin": "string",
nextofKinAddress": "string",
nexofKinEmailAddress": "string",
nextofKinPhone": "string",
nextofKinRelationship": "string",
allowNomineeAccount": true,
termsAndCondAccepted": true,
setttlementBankName": "string",
setttlementBankBranch": "string",
setttlementBankStreet": "string",
setttlementBankCity": "string",
setttlementBankPostState": "string",
setttlementBankPostCode": "string",
setttlementBankPostCountry": "string",
setttlementBankAccountName": "string",
setttlementBankAccountNumber": "string",
setttlementBankAccountSCode": "string",
setttlementBankOpenDate": "2022-05-31T15:48:32.485Z",
setttlementBankName_2": "string",
setttlementBankBranch_2": "string",
setttlementBankStreet_2": "string",
setttlementBankCity_2": "string",
setttlementBankPostState_2": "string",
setttlementBankPostCode_2": "string",
setttlementBankPostCountry_2": "string",
setttlementBankAccountName_2": "string",
setttlementBankAccountNumber_2": "string",
setttlementBankAccountSCode_2": "string",
setttlementBankOpenDate_2": "2022-05-31T15:48:32.485Z",
channel": "string",
lastTransactionDate": "2022-05-31T15:48:32.485Z",
lastTransactionDescr": "string",
portfolios": [
string"
],
picture": "string",
pictureFileName": "string",
pictureMimeType": "string",
signature": "string",
signatureFileName": "string",
signatureMimeType": "string",
identification": "string",
identificationFileName": "string",
identificationMimeType": "string",
utilityBill": "string",
utilityBillFileName": "string",
utilityBillMimeType": "string",
estimatedAnnualIncome": 0,
estimatedNetWorth": 0,
enrollInContribScheme": true,
contribAmount": 0,
sourceOfWealthNotes": "string",
sourceOfWealth": "string",
invstKnowledge": "string",
riskTolerance": "string",
overallInvstObj": "string",
moneyLaunderingRisk": true,
politicallyExposed": true,
criminalConviction": true,
stateOfOrigin": "string",
salesRepId": 0,
salesRepLabel": "string",
salesRepEmail": "string",
salesRepCellPhone": "string",
salesRepOfficePhone": "string",
refName1": "string",
refName2": "string",
refName3": "string",
refName4": "string",
refName5": "string",
residentStatus": "string",
countryOfDomicile": "string",
ficaCompliant": "string",
getdWTExemptCd": "string",
getiWTExemptCd": "string",
getdWTOverridePerc": 0,
getiWTOverridePerc": 0,
taxIdNumber": "string",
accountOpened": "2022-05-31T15:48:32.485Z",
status": "string",
kycStatus": "string",
workflowStatus": "string",
signatory1": "string",
signatory1FileName": "string",
signatory1MimeType": "string",
signatory1Label": "string",
signatory2": "string",
signatory2FileName": "string",
signatory2MimeType": "string",
signatory2Label": "string",
signatory3": "string",
signatory3FileName": "string",
signatory3MimeType": "string",
signatory3Label": "string",
signatory4": "string",
signatory4FileName": "string",
signatory4MimeType": "string",
signatory4Label": "string",
signatory5": "string",
signatory5FileName": "string",
signatory5MimeType": "string",
signatory5Label": "string"
}'
ParameterData TypeDescriptionRequired
activeBooleanUsed to indicate if the client is active or inactiveYes
channelStringMeans of communication. can either be WEB or MOBILEYes
firstNameStringcustomer's first nameYes
lastNameStringcustomer's last nameYes
cellPhoneStringcustomer's cell phone numberYes
emailAddress1Stringcustomer's email addressYes
partnerTypeStringcustomer categoryYes
customerGroupNameStringDefault value: RETAILYes
businessOfficeNameStringDefault value: HQYes

This returns a customer’s KYC details when an ‘id’ is passed. 

#Sample cURL command
curl -X 'GET' \
'https://zas-dev.zanibal.com/api/v1/partner/customer/id/0001' \
-H 'accept: application/json; charset=UTF-8' \

This gives a list of customers and their financial ledger entries.

#Sample cURL command
curl -X 'GET' \
'https://zas-dev.zanibal.com/api/v1/partner/customer/list?orderBy=label&orderDir=ASC&start=0&pageSize=25' \
-H 'accept: application/json; charset=UTF-8' \

This returns all cash account balances belonging to the customer whose ‘id’ is passed as a parameter for a particular value date and currency.

#Sample cURL command
curl -X 'GET' \
'https://zas-dev.zanibal.com/api/v1/partner/cash-account-balances?clientId=001&valueDate=2022-01-01&currency=NGN' \
-H 'accept: application/json; charset=UTF-8' \