Get agent details

Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

Get Agent Profile By ID

Returns the full profile of a specific agent within the ISO associated with the authenticated API user. The profile includes the agent's name, payout number, office details, username, email, and phone. This information is typically used to validate agent details before associating them with a merchant application.

Endpoint

GET /api/v1/agent/profile

Authentication

Basic HTTP Authentication required.
Encode username:password in Base64 and pass in the Authorization header:

Authorization: Basic {base64(username:password)}

When to use

Use this endpoint when you need to look up or confirm the details of a specific agent before associating them with a merchant. It is commonly called after GET /api/v1/agentProfiles to fetch the full detail record for a specific entry from the list. This is also useful for displaying agent information in a boarding portal UI or for audit and reporting purposes.

Query Parameters

Parameter	Type	Required	Description
id	integer (int32)	Yes	The agent profile ID to retrieve

Response

200 OK

Field	Type	Description
data.id	integer	The agent profile ID
data.name	string	Combined display name (typically `payoutNumber + agentName`)
data.payoutNumber	string	The agent's payout number used for commission distribution
data.agentId	integer	The unique identifier of the underlying agent record
data.agentName	string	The agent's full name
data.agentOfficeId	integer	ID of the agent's office/branch
data.agentOfficeName	string	Name of the agent's office/branch
data.agentUserName	string	System username for the agent (e.g., `iso01074-63018`)
data.email	string	Agent's email address
data.phone	string	Agent's phone number
status	string	HTTP status label (e.g., `OK`)
error	string	Error message if the lookup failed
warning	string	Non-fatal warning message, if any
validationResults	array	List of field-level validation errors
requestId	integer	Unique identifier for this API request

{
  "data": {
    "id": 4264,
    "name": "1354275284 Maria Santos",
    "payoutNumber": "1354275284",
    "agentId": 63018,
    "agentName": "Maria Santos",
    "agentOfficeId": 1074,
    "agentOfficeName": "Southwest Regional Office",
    "agentUserName": "iso01074-63018",
    "email": "[email protected]",
    "phone": "305-555-0182"
  },
  "status": "OK",
  "error": null,
  "warning": null,
  "validationResults": [],
  "requestId": 91512
}

Error Codes

Code	When it happens
400	`id` parameter is missing or not a valid integer
401	Invalid or missing Basic Auth credentials
403	User does not have permission for this operation
404	Agent profile with the specified `id` not found or not accessible to this ISO
500	Internal server error

Common Mistakes

Using an id that belongs to an agent outside the authenticated user's ISO — you can only retrieve profiles for agents within your own ISO.
Confusing id (agent profile ID) with agentId (the underlying agent record ID) — use the id returned by GET /api/v1/agentProfiles for this endpoint.
Expecting phone to always be populated — phone is optional in the agent profile and may be null or empty.

Related Endpoints

GET /api/v1/agentProfiles — retrieve all agent profiles for your ISO (use to get valid id values)
POST /api/v1/merchant/create — create a merchant and assign an agent using agentProfileId
GET /api/v1/GetBoardingSettings — retrieve boarding settings to use alongside the agent profile when creating merchants

Example

curl -X GET "https://hq.staging.netevia.dev/api/v1/agent/profile?id=4264" \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)"