Retrieve agent profiles for merchant boarding based on API user's ISO

Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

Get Agent Profiles

Returns a list of all agent profiles belonging to the ISO associated with the authenticated API user. Each profile represents an agent who can be assigned to merchant applications during the boarding process. This is typically the first call made when setting up a new merchant, as the returned id values are required when creating merchant applications.

Endpoint

GET /api/v1/agentProfiles

Authentication

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

Authorization: Basic {base64(username:password)}

When to use

Call this endpoint at the start of the merchant boarding flow to populate the agent selection list in your boarding UI or to determine valid agentProfileId values before calling POST /api/v1/merchant/create. The results are automatically scoped to the ISO tied to your API credentials — no filter parameters are needed. Results should be cached in your application between sessions to reduce unnecessary API calls, but should be refreshed periodically as agents may be added or modified.

Response

200 OK

Field	Type	Description
data	array	List of `AgentProfile` objects for the authenticated ISO
data[].id	integer	Agent profile ID — use this as `agentProfileId` when creating a merchant
data[].name	string	Combined display name (typically `payoutNumber + agentName`)
data[].payoutNumber	string	Agent's payout number for commission tracking
data[].agentId	integer	Unique identifier of the underlying agent record
data[].agentName	string	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
data[].email	string	Agent's email address
data[].phone	string	Agent's phone number (may be null)
status	string	HTTP status label (e.g., `OK`)
error	string	Error message if the request failed
warning	string	Non-fatal warning message, if any
validationResults	array	List of 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"
    },
    {
      "id": 4391,
      "name": "1354275301 James Okafor",
      "payoutNumber": "1354275301",
      "agentId": 63041,
      "agentName": "James Okafor",
      "agentOfficeId": 1074,
      "agentOfficeName": "Southwest Regional Office",
      "agentUserName": "iso01074-63041",
      "email": "[email protected]",
      "phone": null
    }
  ],
  "status": "OK",
  "error": null,
  "warning": null,
  "validationResults": [],
  "requestId": 91648
}

Error Codes

Code	When it happens
401	Invalid or missing Basic Auth credentials
403	User does not have permission to access agent profiles for this ISO
404	No agent profiles found for the ISO associated with this API user
500	Internal server error

Common Mistakes

Hard-coding agent profile IDs — these IDs are environment-specific and will differ between staging and production; always fetch them dynamically.
Not checking for an empty data array — if no agents are configured under the ISO, the array will be empty rather than returning a 404.
Using agentId instead of id when creating a merchant — the id field (not agentId) is the value to pass as agentProfileId in the create merchant request.
Calling this endpoint on every merchant create request without caching — the profile list changes infrequently; cache the results and refresh periodically.

Related Endpoints

GET /api/v1/agent/profile — retrieve the full detail record for a single agent by profile ID
GET /api/v1/GetBoardingSettings — retrieve boarding settings (always call alongside this endpoint before creating a merchant)
POST /api/v1/merchant/create — create a merchant using the agentProfileId returned here

Example

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