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
| Field | Type | Required | Description |
|---|---|---|---|
| agentPayoutProfileId | integer (int32) | Yes | The ID of the payout profile associated with the agent. |
| neteviaProfileId | integer (int32) | Yes | The ID of the Netevia profile record to associate the agent with. |
| salesRepresentativeId | integer (int32) | Yes | The 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
| Field | Type | Description |
|---|---|---|
| profileId | integer (int32) | The ID of the profile that was created or updated. |
| success | boolean | Indicates whether the operation completed successfully. |
| errors | string | null | Error message if the operation failed; null on success. |
| changeLog | array | null | List of changes applied during the request. Each entry contains requestType (integer) and changes (string). |
Open Financial Account Response (extends Boarding Response)
| Field | Type | Description |
|---|---|---|
| profileId | integer (int32) | The ID of the profile that was created or updated. |
| success | boolean | Indicates whether the operation completed successfully. |
| errors | string | null | Error message if the operation failed; null on success. |
| changeLog | array | null | List of changes applied during the request. |
| financialAccountId | string | null | The 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
| Code | When it happens |
|---|---|
| 400 | Missing required fields (agentPayoutProfileId, neteviaProfileId, or salesRepresentativeId) or validation error in the request body |
| 401 | Token missing, expired, or invalid |
| 403 | Insufficient permissions to set agent profile data |
| 404 | Referenced profile ID or sales representative ID not found |
| 500 | Internal 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
salesRepresentativeIdoragentPayoutProfileIdthat does not exist in the system will return a 404 or validation error.
Related Endpoints
POST /api/auth/v2— Obtain a Bearer token for authenticationPOST /api/auth/refresh— Refresh an existing Bearer tokenPOST /netevia/profile/business— Create or update a business profilePOST /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
}'