Set agent's data

Set Agent Profile Data

This endpoint creates or updates an agent's profile in the Netevia banking platform. It links a sales representative and a payout profile to a Netevia profile record, establishing the agent's relationship within the boarding system. Use this endpoint during onboarding workflows to associate agent-level configuration with a platform profile.

Endpoint

POST /netevia/profile/agent

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Use this endpoint when onboarding a new agent or updating an existing agent's profile associations. It is typically called during partner boarding flows to bind a payout configuration and sales representative to a Netevia profile. This endpoint is part of the Boarding tag group and supports agent management within the platform.

Request Body

FieldTypeRequiredDescription
agentPayoutProfileIdinteger (int32)YesThe ID of the payout profile associated with the agent.
neteviaProfileIdinteger (int32)YesThe ID of the Netevia profile record to associate the agent with.
salesRepresentativeIdinteger (int32)YesThe ID of the sales representative linked to this agent profile.
{
  "agentPayoutProfileId": 1042,
  "neteviaProfileId": 8831,
  "salesRepresentativeId": 305
}

Response

200 OK

The response may return either a standard boarding response or an open financial account response (which extends the boarding response with a financial account ID).

Boarding Response

FieldTypeDescription
profileIdinteger (int32)The ID of the profile that was created or updated.
successbooleanIndicates whether the operation completed successfully.
errorsstring | nullError message if the operation failed; null on success.
changeLogarray | nullList of changes applied during the request. Each entry contains requestType (integer) and changes (string).

Open Financial Account Response (extends Boarding Response)

FieldTypeDescription
profileIdinteger (int32)The ID of the profile that was created or updated.
successbooleanIndicates whether the operation completed successfully.
errorsstring | nullError message if the operation failed; null on success.
changeLogarray | nullList of changes applied during the request.
financialAccountIdstring | nullThe ID of the financial account opened as part of this request, if applicable.
{
  "profileId": 8831,
  "success": true,
  "errors": null,
  "changeLog": [
    {
      "requestType": 1,
      "changes": "Agent payout profile linked."
    }
  ]
}

Error Codes

CodeWhen it happens
400Missing required fields (agentPayoutProfileId, neteviaProfileId, or salesRepresentativeId) or validation error in the request body
401Token missing, expired, or invalid
403Insufficient permissions to set agent profile data
404Referenced profile ID or sales representative ID not found
500Internal server error

Common Mistakes

  • Omitting any of the three required fields (agentPayoutProfileId, neteviaProfileId, salesRepresentativeId) will result in a 400 error.
  • Passing string values instead of integers for ID fields — all ID fields must be numeric (int32).
  • Using an expired or missing Bearer token; tokens are valid for only 10 minutes and must be refreshed via POST /api/auth/refresh.
  • Referencing a salesRepresentativeId or agentPayoutProfileId that does not exist in the system will return a 404 or validation error.

Related Endpoints

  • POST /api/auth/v2 — Obtain a Bearer token for authentication
  • POST /api/auth/refresh — Refresh an existing Bearer token
  • POST /netevia/profile/business — Create or update a business profile
  • POST /netevia/profile/personal — Create or update a personal profile

Example

curl -X POST https://api.banking.netevia.dev/netevia/profile/agent \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "agentPayoutProfileId": 1042,
    "neteviaProfileId": 8831,
    "salesRepresentativeId": 305
  }'
Body Params
int32
required
int32
required
int32
required
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json