Get User Details API

Retrieves user details using a specific user ID. Available to SUPER_ADMIN, PARTNER, MERCHANT, and BRANCH roles.

Overview

The Get User Details API retrieves information about a specific user using their unique user ID.

  • HTTP Method: GET
  • Endpoint: /api/v1/users/user/USERID
  • Access Levels: SUPER_ADMIN, PARTNER, MERCHANT, BRANCH

Authentication

Include your API key in the request headers.

HeaderValue
X-API-KEYYOUR_API_KEY
Accept*/*

Production Base URL: https://app-api.edfapay.com

Path Parameters

ParameterTypeRequiredDescription
userIdUUIDYesThe unique identifier of the user whose details are being retrieved.

Request Example

cURL

curl --request GET \
  --url 'https://app-api.edfapay.com/api/v1/users/user/USERID' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Accept: */*'

Replace USERID with the actual user's UUID.

Example URL

https://app-api.edfapay.com/api/v1/users/user/3fa85f64-5717-4562-b3fc-2c963f66afa6

Responses

200 OK

The request was processed successfully.

Example response:

{
  "code": 0,
  "message": "string",
  "errorCode": "string",
  "data": {}
}

The data field is represented as an empty object in the published response example. The detailed user response schema is not specified in the provided API documentation.

400 Bad Request

The request could not be processed because of invalid request data or a malformed user ID.

Example response:

{
  "code": 0,
  "message": "string",
  "errorCode": "string",
  "data": {}
}

Integration Notes

  • Provide a valid UUID in the userId path parameter.
  • Ensure the API key is valid and the caller has the required access level.
  • Handle the response using the returned HTTP status and response fields.
  • The provided specification does not define a separate response schema for user details or document a 404 Not Found response.

Did this page help you?