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

API Endpoint: GET /api/v1/agentProfiles

Overview:

The GET /api/v1/agentProfiles API method retrieves a list of agent profiles associated with the Independent Sales Organization (ISO) that is linked to the API user's account. This endpoint is specifically designed for merchant boarding purposes, allowing the system to retrieve detailed information about agents under the API user's ISO, which is often essential in managing and tracking the progress of the merchant onboarding process.

Purpose:

The endpoint is used to retrieve agent profiles for an ISO. These agents play a key role in onboarding merchants, and their profiles provide details such as personal information, business details, and status within the system. This allows the ISO to monitor and manage its agents effectively during the merchant boarding process.

HTTP Request Method:

• GET

URL:

• /api/v1/agentProfiles

Authentication:

• Required: Yes
• Authentication Method: Basic Token or API Key provided in the request header.

Request Headers:

• Authorization: Basic <token> (required) - Used for authenticating the API call based on the API user's ISO.
• Content-Type: application/json (optional).

Success Response:

• Status Code: 200 OK
• Response Body (JSON format):
  JSON

  {
  "data": [
    {
    {
      "id": 4264,
      "name": "1354275284 Bob Bob",
      "payoutNumber": "1354275284",
      "agentId": 63018,
      "agentName": "Bob Bob",
      "agentOfficeId": 1074,
      "agentOfficeName": "Test24",
      "agentUserName": "iso01074-63018",
      "email": "[email protected]"
    }
  ],
  "status": 200
  }
  

Error Responses:

• 401 Unauthorized:
  • Occurs if the request lacks valid authentication credentials.
  • Response body:
    JSON

    {
      "error": "Unauthorized",
      "message": "Invalid or missing token"
    }
    

• 403 Forbidden:
  • Occurs if the API user does not have permission to access agent profiles for the given ISO.
  • Response body:
    JSON

    {
      "error": "Forbidden",
      "message": "You do not have permission to access this resource"
    }
    

• 404 Not Found:
  • Occurs if no agent profiles are found for the specified ISO.
  • Response body:
    JSON

    {
      "error": "Not Found",
      "message": "No agent profiles found for the ISO"
    }
    

Notes:

• The returned agent profiles are restricted to those belonging to the ISO associated with the API user's token.