Unlock Access for the Customer
This endpoint allows authorized systems to unlock access to a customer's account by specifying their profile ID. It restores normal account functionality for customers whose access has been restricted due to security protocols or administrative actions. Use this endpoint to minimize disruption and allow customers to resume their standard banking operations promptly.
Endpoint
POST /netevia/unlockaccess/{profileId}
Authentication
Bearer token required. Obtain via:
POST https://api.banking.netevia.dev/api/auth/v2Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.
When to use
Use this endpoint when a customer's account access has been suspended or locked and needs to be restored. This is appropriate after the reason for the lock has been resolved — such as a completed security review, identity verification, or after a customer-initiated hold has been lifted. This endpoint ensures that access restoration follows secure, auditable processes.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| profileId | integer (int32) | Yes | The unique identifier of the customer profile whose access is to be unlocked. |
Response
200 OK
The response may return one of two schema variants depending on context. Both extend a common boarding response structure.
boardingresponse fields:
| Field | Type | Description |
|---|---|---|
| profileId | integer (int32) | The profile ID of the customer whose access was unlocked. |
| errors | string or null | Error message if the operation encountered an issue; null on success. |
| success | boolean | Indicates whether the unlock operation completed successfully. |
| changeLog | array or null | List of change log entries describing what was modified during the operation. |
changeLog item fields:
| Field | Type | Description |
|---|---|---|
| requestType | integer (int32) | Enum value representing the type of banking request that was processed. |
| changes | string or null | Description of the specific change that was applied. |
openfinancialaccountresponse (extends boardingresponse — returned when a financial account action is also performed):
| Field | Type | Description |
|---|---|---|
| financialAccountId | string or null | The identifier of the financial account affected, if applicable. |
{
"profileId": 100234,
"errors": null,
"success": true,
"changeLog": [
{
"requestType": 3,
"changes": "Account access restored for profile 100234."
}
]
}Error Codes
| Code | When it happens |
|---|---|
| 400 | Missing required fields or validation error |
| 401 | Token missing, expired, or invalid |
| 403 | Insufficient permissions to unlock the specified profile |
| 404 | Profile not found for the provided profileId |
| 500 | Internal server error |
Common Mistakes
- Providing a
profileIdthat does not exist or belongs to a different partner's customer, resulting in a 404 or 403 error. - Using an expired Bearer token — tokens last only 10 minutes and must be refreshed before making this call.
- Attempting to unlock an account that is not currently locked, which may result in a no-op or an unexpected error response.
- Omitting the
profileIdpath parameter, which will cause the request to route to an incorrect or non-existent endpoint.
Related Endpoints
POST /netevia/lockaccess/{profileId}— Restricts access to a customer's account by profile ID.POST /api/auth/v2— Obtain a Bearer authentication token.POST /api/auth/refresh— Refresh an existing Bearer token before it expires.
Example
curl -X POST https://api.banking.netevia.dev/netevia/unlockaccess/100234 \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json"