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**
| Name | Description | Required | Type |
|---|---|---|---|
| firstName | Client's first name | Required | String |
| lastName | Client's last name | Required | String |
| otherNames | Middle or other names | Not Required | String |
| Email address of the client | Not Required | String | |
| address | Address of the client. >=5 characters | Not Required | string |
| city | The name of the city where the client is located | Not Required | String |
| profileImage | Profile picture | Not Required | String |
| region | Region/State name | Not Required | String |
| country | The country of the client | Required | String |
| password | Account password code | Not Required | string |
| phoneMumber | Client's phone number | Not Required | string |
| type | The type of client | Required | string |
| isActive | The status of the account | Not Required | String |
| identificationCard | The no of the ID card | Not Required | object |
| gender | The gender of the client. Enum:"MALE" "FEMALE" "OTHER" | Not Required | string |
| taxpayerIdentificationNumber | TIN number of client | Not Required | String |
authorization : `*bearer`
REQUEST BODY SCHEMA: `application/json`
Client: `**CorporateClientDto**`
| Name | Description | Required | Type |
|---|---|---|---|
| companyName | Company name | Required | String |
| contactPersons | Contact persons details | Not Required | Array |
| dateOfIncorporation | Date the company was incorporated | Not Required | String |
| Email address of the client | Not Required | String | |
| digitalAddress | Digital address (Ghana Post GPS address) of the client | Not Required | string |
| city | The name of the city where the client is located | Not Required | String |
| profileImage | Profile picture | Not Required | String |
| region | Region/State name | Not Required | String |
| country | The country of the client | Required | String |
| password | Account password | Not Required | string |
| phoneMumber | Client's phone number | Not Required | string |
| type | The type of client | Required | string |
| isActive | The status of the account | Not Required | String |
| industry | Industry of the client | Not Required | String |
| identificationCard | The no of the ID card | Not Required | object |
| gender | The gender of the client. Enum:"MALE" "FEMALE" "OTHER" | Not Required | string |
| taxpayerIdentificationNumber | TIN number of client | Not Required | String |
Response
| Code | Description |
|---|---|
| 200 | updated account information |
| 409 | Unauthorized |
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": [
+ {}
]
}
...
]