Get Accounts By PhoneNumber

This Request API allow you to Retrieve all accounts to a given phone number.

GET /api/account/v1/GetAccountsByPhoneNumber

This endpoint uses the phone number supplied to return all accounts tied to it.

Headers

Name	Value
Content-Type*	application/json
Authorization*	bearer <token>
Request-reference*	{unique_reference}

Params

Name	Data Type (Length)	Required	Description
PhoneNumber	string	Required	The phone number to search accounts by

Body

Name	Data Type	Description
accountNumber	string	The account number
customerID	string	Unique ID of the customer
accountName	string	Name on the account
accountType	string	Type of account
accountStatus	string	Current status of the account
firstName	string	Customer's first name
lastName	string	Customer's last name
otherNames	string	Customer's other names
address	string	Customer's residential address
email	string	Customer's email address
recordCount	number	Total number of accounts matched

Sample API Request

Curl

curl --location -g '{{baseurl}}/api/account/v1/GetAccountsByPhoneNumber?PhoneNumber={{PhoneNumber}}' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data ''

Response

json

{
  "status": true,
  "message": "string",
  "data": {
    "data": [
      {
        "accountNumber": "string",
        "customerID": "string",
        "accountName": "string",
        "accountType": "string",
        "accountStatus": "string",
        "firstName": "Adebayo",
        "lastName": "Olufemi",
        "otherNames": "Emmanuel",
        "address": "XYZ Acme road",
        "email": "[e-mail]"
      }
    ],
    "recordCount": 0
  }
}

data.data is an array, it returns one entry per account linked to the phone number. recordCount shows the total number of accounts matched.