Onboarding
Individual accounts
Customer details
Get details of external customer
Request parameters
Responses
{
"reference": "66d829fc09a75c584c885571",
"partnerReference": "partnera902883289932",
"firstName": "JONATHON",
"lastName": "JOHNSON",
"phoneNumber": "+23324000000000",
"identificationType": "GHANA_CARD",
"identificationNumber": "GHA-200200201-0",
"accountType": "MKYC",
"status": "PENDING",
"currentState": "CREATION",
"idVerificationStatus": "PASSED"
}
MKYC
Create an individual MKYC account for customer
Request parameters
{
"firstName": "Kofi",
"lastName": "Dee",
"nationality": "GH",
"phoneNumber": "+233540000000",
"identificationType": "GHANA_CARD",
"identificationNumber": "GHA-000000000-0",
"profilePicture": "PROFILE_PICTURE/customer-face.jpeg",
"ghanaPostAddress": "",
"identificationFileKey": "",
"identificationBackFileKey": "",
"residencyPermitNumber": "",
"residencyPermitIssueDate": "",
"residencyPermitExpiryDate": "",
"residencyPermitFileKey": ""
"accountManagementType": "NOT_MANAGED",
}
Responses
MKYC Update
Update MKYC customer details
Request parameters
{
"profilePictureFileKey": "PROFILE_PICTURE/636c80ff-eff4-4f50-93b9-52a7dcacd995.jpeg",
"identificationType": "",
"identificationNumber": "",
"identificationFileKey": "",
"identificationBackFileKey": ""
}
Responses
EKYC upgrade
Upgrade an individual MKYC account to an EKYC account
Request parameters
{
"maritalStatus": "Divorced",
"nextOfKinName": "Afi Nti",
"nextOfKinPhoneNumber": "+233540000002",
"nextOfKinRelationship": "SPOUSE",
"numberOfTransactionsPerMonth": "MAX19",
"employmentStatus": "EMPLOYED",
"employmentSector": "Agriculture, forestry and fishing",
"employmentIndustry": "Agricultural services",
"employmentOccupation": "Horticultural trader",
"employmentSourceOfFunds": "BUSINESS_PROCEEDS",
"employmentOtherSourceOfFunds": "example",
"employmentInstitutionName": "example",
"employmentIncomeRange": "LESS_THAN_1000",
"employerName": "example",
"employerGhanaPostAddress": "GE-902-9929",
"physicallyChallenged": "YES",
"disabilityType": [
"VISION_IMPAIRMENT"
]
}
Responses
{
"message": "example",
"reference": "example"
}
Business accounts
Get business account details
Get business account details
Request parameters
Responses
{
"reference": "example",
"name": "example",
"registrationNumber": "example",
"registrationDate": "example",
"businessType": "SOLE_PROPRIETOR",
"registrationType": "UNREGISTERED",
"ownershipType": "PUBLIC",
"isLicenseRequired": true,
"address": {
"houseNumber": "example",
"streetName": "example",
"area": "example",
"city": "example",
"ghanaGPSAddress": "example"
},
"email": "example",
"phoneNumber": "example",
"secondaryPhoneNumber": "example",
"TIN": "example",
"sector": "example",
"industry": "example",
"annualTurnover": "example",
"sourceOfFunds": "BUSINESS_PROCEEDS",
"website": "example",
"noRequiredSignatories": 4,
"documents": {
"certificateOfRegistrationFile": "example",
"ammendmentToRegistrationFile": "example",
"annualRenewalReceiptFile": "example",
"businessRegulationFile": "example",
"partnershipAgreementFile": "example",
"certificateOfIncorporationFile": "example",
"endorsedConstitutionFile": "example",
"publicVerificationProofFile": "example"
},
"directors": [
{
"title": "Mr",
"firstName": "example",
"lastName": "example",
"otherNames": "example",
"address": {
"houseNumber": "example",
"streetName": "example",
"area": "example",
"city": "example",
"ghanaGPSAddress": "example"
},
"email": "example",
"nationality": "example",
"phoneNumber": "example",
"secondaryPhoneNumber": "example",
"position": "DIRECTOR",
"shareholderType": "INDEPENDENT_SHAREHOLDER",
"photoKey": "example",
"sourceOfFunds": "BUSINESS_PROCEEDS",
"isDirector": true,
"isShareholder": false,
"isSignatory": true,
"signatureKey": "example",
"identification": {
"idType": "GHANA_CARD",
"number": "example",
"issueDate": "example",
"expiryDate": "example",
"fileKey": "example",
"backFileKey": "example"
}
}
],
"businessShareholders": [
{
"name": "example",
"registrationNumber": "example",
"registrationDate": "example",
"businessType": "SOLE_PROPRIETOR",
"registrationType": "UNREGISTERED",
"ownershipType": "PUBLIC",
"isLicenseRequired": true,
"address": {
"houseNumber": "example",
"streetName": "example",
"area": "example",
"city": "example",
"ghanaGPSAddress": "example"
},
"email": "example",
"phoneNumber": "example",
"secondaryPhoneNumber": "example",
"TIN": "example",
"sector": "example",
"industry": "example",
"website": "example",
"documents": {
"certificateOfRegistrationFile": "example",
"ammendmentToRegistrationFile": "example",
"annualRenewalReceiptFile": "example",
"businessRegulationFile": "example",
"partnershipAgreementFile": "example",
"certificateOfIncorporationFile": "example",
"endorsedConstitutionFile": "example",
"publicVerificationProofFile": "example"
}
}
],
"accountState": "example"
}
Onboarding
Submit business details
Save business core details and required documents
Request parameters
Responses
{
"name": "Affinity",
"TIN": "AFF000001",
"registrationNumber": null,
"registrationDate": null,
"businessType": "SOLE_PROPRIETOR",
"registrationType": null,
"nonProfitType": null,
"ownershipType": null,
"isLicenseRequired": false,
"address": {
"houseNumber": null,
"streetName": "street",
"area": "Osu",
"city": "Accra",
"ghanaGPSAddress": null
},
"email": null,
"phoneNumber": "+233500000000",
"secondaryPhoneNumber": null,
"sector": "SC0001",
"industry": "ID0001",
"annualTurnover": null,
"sourceOfFunds": "BUSINESS_PROCEEDS",
"website": null,
"noRequiredSignatories": 1,
"certificateOfRegistrationFile": "BUSINESS_DOCUMENTS/REGISTRATION_CERTIFICATE/upload-a-file.pdf",
"ammendmentToRegistrationFile": null,
"annualRenewalReceiptFile": null,
"businessRegulationFile": null,
"partnershipAgreementFile": null,
"certificateOfIncorporationFile": null,
"endorsedConstitutionFile": null,
"publicVerificationProofFile": null
}
Submit business directors
Store information on the people in the business (directors, shareholders, signatories)
Request parameters
{
"directors": [
{
"title": "Mr",
"firstName": "example",
"lastName": "example",
"otherNames": "example",
"address": {
"houseNumber": "example",
"streetName": "example",
"area": "example",
"city": "example",
"ghanaGPSAddress": "example"
},
"email": "example",
"nationality": "example",
"phoneNumber": "example",
"secondaryPhoneNumber": "example",
"position": "DIRECTOR",
"shareholderType": "INDEPENDENT_SHAREHOLDER",
"photoKey": "example",
"sourceOfFunds": "BUSINESS_PROCEEDS",
"isDirector": true,
"isShareholder": false,
"isSignatory": true,
"signatureKey": "example",
"identification": {
"idType": "GHANA_CARD",
"number": "example",
"issueDate": "example",
"expiryDate": "example",
"fileKey": "example",
"backFileKey": "example"
}
}
]
}
Responses
{
"message": "example",
"reference": "example"
}
Submit business shareholders
Add shareholders which are businesses
Request parameters
{
"businessShareholders": [
{
"name": "example",
"registrationNumber": "example",
"registrationDate": "example",
"businessType": "SOLE_PROPRIETOR",
"registrationType": "UNREGISTERED",
"nonProfitType": "NGO",
"ownershipType": "PUBLIC",
"isLicenseRequired": true,
"address": {
"houseNumber": "example",
"streetName": "example",
"area": "example",
"city": "example",
"ghanaGPSAddress": "example"
},
"email": "example",
"phoneNumber": "example",
"secondaryPhoneNumber": "example",
"TIN": "example",
"sector": "example",
"industry": "example",
"annualTurnover": "example",
"sourceOfFunds": "BUSINESS_PROCEEDS",
"website": "example",
"noRequiredSignatories": 4,
"certificateOfRegistrationFile": "example",
"ammendmentToRegistrationFile": "example",
"annualRenewalReceiptFile": "example",
"businessRegulationFile": "example",
"partnershipAgreementFile": "example",
"certificateOfIncorporationFile": "example",
"endorsedConstitutionFile": "example",
"publicVerificationProofFile": "example"
}
]
}
Responses
{
"message": "example",
"reference": "example"
}
Complete business application
Complete business onboarding
Request parameters
Responses
{
"message": "example",
"reference": "example"
}
Last modified: 27 August 2025