Get Full Account Details

Returns the full profile of a client together with its directors and signatories (business clients).

GET /core/account/fulldetails/{clientId}

Path Parameter

Field Name	Type	Required	Description
`clientId`	integer	TRUE	Core banking client identifier.

Query Parameters

Field Name	Type	Required	Description
`type`	string	FALSE	`PERSON` or `BUSINESS`. When supplied the call fails if the client is of the other type. Other values are ignored.
`showsenstivedata`	boolean	FALSE	Spelled exactly like this. When `false`, `bvn` and `nin` are removed from the client, directors and signatories. Omitted or `true` returns them.

Response

Field Name	Type	Description
`clientType`	string	`PERSON` or `BUSINESS`.
`clientDetails`	object	Profile of the client (names, contacts, `bvn`, `nin`, office, KYC level, notification flags, first address, dates in dd-MM-yyyy).
`directors`	array	Same shape as `clientDetails`, one entry per active director. Absent when none.
`signatories`	array	Same shape as `clientDetails`, one entry per active signatory. Absent when none.

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: {{tpGatewayHostUrl}}/security/authenticate

Responses

🟢200Success

application/json

Success

Bodyapplication/json

Example

{
  "clientType": "PERSON",
  "clientDetails": {
    "id": 101,
    "status": "Active",
    "active": true,
    "firstname": "Ada",
    "lastname": "Sample",
    "fullName": "Ada Sample",
    "mobileNo": "08000000000",
    "email": "ada@example.com",
    "nin": "10000000001",
    "bvn": "22000000001",
    "officeId": 1,
    "officeName": "Head Office",
    "savingsAccountId": 55,
    "clientType": "PERSON",
    "kycLevel": 1,
    "emailNotification": true,
    "smsNotification": true,
    "clientActivationFeePaid": false,
    "isStaff": false,
    "activationDate": "01-06-2025",
    "dateOfBirth": "01-01-1990",
    "gender": "Female",
    "genderId": 2,
    "addressTypeId": 81,
    "addressType": "Home Address",
    "addressLine1": "12 Sample Street",
    "city": "Sample City",
    "state": "Sample State",
    "stateId": 12,
    "country": "Nigeria"
  }
}

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠403| Source | Error | When |

🟠404| Source | Error | When |

🔴500| Source | Error | When |

Get Full Account Details