Skip to main content

Update Account

Updates client's account information. The endpoint below allows users to update their account.

PATCH /api/v1/client/account

Path param

authorization : *bearer
REQUEST BODY SCHEMA: application/json Client: **IndividualClientDto**


NameDescriptionRequiredType
firstNameClient's first name RequiredString
lastNameClient's last name RequiredString
otherNamesMiddle or other namesNot RequiredString
emailEmail address of the clientNot RequiredString
addressAddress of the client. >=5 charactersNot Requiredstring
cityThe name of the city where the client is locatedNot RequiredString
profileImageProfile pictureNot RequiredString
regionRegion/State nameNot RequiredString
countryThe country of the client RequiredString
passwordAccount password codeNot Requiredstring
phoneMumberClient's phone numberNot Requiredstring
typeThe type of client Requiredstring
isActiveThe status of the accountNot RequiredString
identificationCardThe no of the ID cardNot Requiredobject
genderThe gender of the client. Enum:"MALE" "FEMALE" "OTHER"Not Requiredstring
taxpayerIdentificationNumberTIN number of clientNot RequiredString


authorization : `*bearer`
REQUEST BODY SCHEMA: `application/json`
Client: `**CorporateClientDto**`
NameDescriptionRequiredType
companyNameCompany name RequiredString
contactPersonsContact persons detailsNot RequiredArray
dateOfIncorporationDate the company was incorporatedNot RequiredString
emailEmail address of the clientNot RequiredString
digitalAddressDigital address (Ghana Post GPS address) of the clientNot Requiredstring
cityThe name of the city where the client is locatedNot RequiredString
profileImageProfile pictureNot RequiredString
regionRegion/State nameNot RequiredString
countryThe country of the client RequiredString
passwordAccount passwordNot Requiredstring
phoneMumberClient's phone numberNot Requiredstring
typeThe type of client Requiredstring
isActiveThe status of the accountNot RequiredString
industryIndustry of the clientNot RequiredString
identificationCardThe no of the ID cardNot Requiredobject
genderThe gender of the client. Enum:"MALE" "FEMALE" "OTHER"Not Requiredstring
taxpayerIdentificationNumberTIN number of clientNot RequiredString

Response

CodeDescription
200updated account information
409Unauthorized

Request Sample

Content type
application/json

[
{
"email": "user@example.com",
"country": "Ghana",
"city": "Accra",
"region": "Greater Accra",
"digitalAddress": "CC-1334-332",
"password": "password",
"industry": "Agriculture",
"address": "Dansoman Street 12, Accra, Ghana",
"type": "CORPORATE",
"profileImage": { },
"firstName": "John",
"lastName": "Doe",
"otherNames": "Wood",
"title": "Mr",
"gender": "Male",
"dateOfBirth": "string",
"identificationCard": {
"idNumber": "123456789",
"type": "GHANA_CARD",
"issueDate": "string",
"expiryDate": "string"
},
"taxpayerIdentificationNumber": "string",
"phoneNumber": "stringstri",
"isActive": true
}
...
]

Request Sample

Content type
application/json

[
{
"statusCode": 200,
"success": true,
"data": [
+ {}
]
}
...
]