Lock/Unlock Customer Temporarily

This endpoint allows partners to temporarily lock or unlock a customer's profile by updating the account status based on the provided profile ID. When locked, the customer loses access to their account and card transactions are optionally suspended. When unlocked, normal account access is restored.

Endpoint

POST /netevia/lock/{profileId}

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 to temporarily restrict a customer's account access during sensitive operations such as account investigations, suspected fraud, or security reviews. It is also useful when a customer requests a temporary hold on their account, or when a partner needs to suspend access while account changes are being processed.

Path Parameters

Request Body

{
  "profileId": 10045,
  "notes": "Temporary lock pending fraud review",
  "isLocked": true,
  "cardsUpdateType": 1
}

Response

200 OK

{
  "profileId": 10045,
  "errors": null,
  "success": true,
  "changeLog": [
    {
      "requestType": 3,
      "changes": "Account status updated to locked"
    }
  ]
}

Error Codes

Common Mistakes

• Setting isLocked: true in the request body but providing a different profileId in the body than in the path — the path parameter takes precedence for identifying the profile
• Not specifying cardsUpdateType when intending to also lock or unlock associated payment cards, resulting in cards remaining in their previous state
• Forgetting to unlock the profile after a temporary security hold, leaving the customer permanently locked out
• Using cardsUpdateType: 2 (unlock cards) while setting isLocked: true (locking the account), which creates an inconsistent state where the account is locked but cards remain active

Related Endpoints

• POST /netevia/boarding/business — Create a new business customer profile
• POST /netevia/boarding/personal — Create a new personal customer profile
• PUT /netevia/profile/{profileId} — Update customer profile details
• GET /netevia/profile/{profileId} — Retrieve customer profile information

Example

curl -X POST https://api.banking.netevia.dev/netevia/lock/10045 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "profileId": 10045,
    "notes": "Temporary lock pending fraud review",
    "isLocked": true,
    "cardsUpdateType": 1
  }'