Account Information

GET /accounts/enquiry/{enquiryParam}

Description

Retrieve account information based on the provided tag, phone number, email, or user ID.

Path Parameters

Name	Type	Description
enquiryParam	string	(Required). Parameter for the account enquiry. It could be a tag, phone number, email, or user ID. Include in the request path.

Try it yourself

curl --location --globoff 'http://20.87.230.105/platform/wallets/accounts/enquiry/`{enquiryParam}`' \
--header 'apiKey: 6987f1c0-f01f-4b31-86e5-416ccaa906de' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2NGQ2NmNmYWQ2NWQ1NTNhZDYwOTBiY2IiLCJmaXJzdE5hbWUiOiJTQUJJIE5HIiwibGFzdE5hbWUiOiJQbGF0Zm9ybSIsInVzZXJuYW1lIjoidGVjaEBzYWJpLmFtIiwicGFzc3dvcmQiOm51bGwsInR5cGUiOiJVU0VSIiwiY291bnRyeSI6eyJuYW1lIjoiTmlnZXJpYSIsImNvZGUiOiJORyIsImN1cnJlbmN5IjoiTkdOIiwiX2lkIjoiNjRkNjZjZmFkNjVkNTUzYWQ2MDkwYmNjIn0sInRlbmFudHMiOlsiNjRkYjY4NmIzZjljNGJjMThkNWM2NTA3IiwiNjRmYjMzYjEwMTUzMWNkYWFhZTlkMzM5Il0sInJvbGVzIjpbIlRFTkFOVF9TVVBFUl9BRE1JTiIsIlRFTkFOVF9BRE1JTiJdLCJpYXQiOjE3MDIyOTgyODgsImV4cCI6MTcwMjkwMzA4OH0.9BIMwE8o52p1-KPX9M7xmtXVNC86yWypbUejtMpvJC8'

Response Code: 200 - OK

Description

Account returned successfully.

Response Field

Field	Type	Description
status	boolean	Indicates the overall success of the operation.
statusCode	integer	Represents the specific status code for the response.
message	string	Provides additional information about the response.
data	object	Contains the main data payload of the response.
errors	array	An array containing error details if issues occurred.
- message	string	Describes the error.
- descriptiveMessage	string	Provides a more detailed and descriptive message about the error.

Example

<response>
  <status>true</status>
  <statusCode>0</statusCode>
  <message>string</message>
  <data></data>
  <errors>
    <error>
      <message>string</message>
      <descriptiveMessage>string</descriptiveMessage>
    </error>
  </errors>
</response>

---

Response Code: 400 - Bad Request

Description

Invalid account tag/phone.

Example

<response>
  <status>false</status>
  <statusCode>400</statusCode>
  <message>Invalid account id</message>
  <data></data>
  <errors>
    <error>
      <message>Invalid account id</message>
      <descriptiveMessage></descriptiveMessage>
    </error>
  </errors>
</response>

Response Code: 404 - Not Found

Description

Account not found.

Example

<response>
  <status>false</status>
  <statusCode>404</statusCode>
  <message>Account id not found</message>
  <data></data>
  <errors>
    <error>
      <message>Account id not found</message>
      <descriptiveMessage></descriptiveMessage>
    </error>
  </errors>
</response>

Method: GET

>http://20.87.230.105/platform/wallets/accounts/enquiry/{enquiryParam}

Headers

Content-Type	Value
apiKey	{{apiKey}}

🔑 Authentication bearer

Param	value	Type
token	{{accessCode}}	string