Update Status main profile

Update Banking Status - Main Profile

This endpoint allows administrators and authorized partners to update the banking application status of a user's main profile in the Netevia banking system. It supports status transitions such as approving, suspending, or reactivating a profile. Only authenticated users with appropriate permissions may invoke this endpoint.

Endpoint

POST /netevia/profile/changeBankingStatus

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 an administrative or support workflow requires modifying the banking status of a customer's main profile — for example, moving a profile from PendingUW to ApprovedUW after underwriting review, suspending an account by setting it to Closed or Cancelled, or reactivating a profile by transitioning it back to Approved. It is also used internally by automated underwriting flows that progress profiles through the approval pipeline.

Query Parameters

ParameterTypeRequiredDescription
ProfileIdinteger (int32)NoThe internal Netevia profile ID of the user whose banking status is being updated.
BankingStatusstring (enum)NoThe new banking status to apply. See allowed values below.
NotesstringNoOptional notes or reason for the status change, useful for audit trails.
NeteviaUserProfileIdinteger (int32)NoThe Netevia user profile ID, used to identify the acting user when applicable.

BankingStatus Allowed Values

ValueDescription
NewProfile has been created but not yet submitted.
SubmittedApplication has been submitted for review.
PendingUWApplication is pending underwriting review.
ApprovedUWApplication has been approved by underwriting.
ClosedAccount has been closed.
CancelledApplication or account has been cancelled.
Pending_ReviewProfile is under manual review.
DeniedApplication has been denied.
ApprovedProfile has been fully approved.
PendingProfile is in a pending state awaiting action.
InReviewProfile is actively being reviewed.
AutoApprovedUWProfile was automatically approved by underwriting.

Response

200 OK

The response may return one of two schemas depending on whether a financial account was opened as part of the status change.

BoardingResponse

FieldTypeDescription
profileIdintegerThe profile ID of the updated user.
errorsstring (nullable)Error message if the operation encountered an issue; null on success.
successbooleanIndicates whether the status update was successful.
changeLogarray (nullable)List of change log entries describing what was modified.

changeLog item

FieldTypeDescription
requestTypeinteger (enum)Numeric code representing the type of banking request performed.
changesstring (nullable)Description of the specific changes made during this request.

OpenFinancialAccountResponse (extends BoardingResponse)

FieldTypeDescription
financialAccountIdstring (nullable)ID of the financial account opened as a result of the status change, if applicable.
{
  "profileId": 10482,
  "errors": null,
  "success": true,
  "changeLog": [
    {
      "requestType": 3,
      "changes": "Banking status updated to Approved"
    }
  ]
}

With financial account opened:

{
  "profileId": 10482,
  "errors": null,
  "success": true,
  "changeLog": [
    {
      "requestType": 3,
      "changes": "Banking status updated to ApprovedUW; financial account created"
    }
  ],
  "financialAccountId": "fa_8c3d2e1f4a9b7056"
}

Error Codes

CodeWhen it happens
400Missing required fields or validation error (e.g., invalid BankingStatus value)
401Token missing, expired, or invalid
403Insufficient permissions to change banking status
404Profile not found for the given ProfileId
500Internal server error

Common Mistakes

  • Passing an invalid BankingStatus string value not in the allowed enum list will result in a 400 error. Use only the exact values listed above.
  • Omitting ProfileId when intending to target a specific profile may result in no update being applied or an unintended profile being modified.
  • Using an expired Bearer token (lifetime is 10 minutes) will result in a 401 response. Refresh via POST /api/auth/refresh before retrying.
  • Attempting to set a status that represents an illogical transition (e.g., moving from Approved back to New) may succeed at the API level but can cause downstream workflow issues — validate status transitions in your business logic.

Related Endpoints

  • POST /api/auth/v2 — Obtain a Bearer authentication token
  • POST /api/auth/refresh — Refresh an existing Bearer token
  • POST /netevia/profile — Create a new main profile
  • GET /netevia/profile — Retrieve main profile details

Example

curl -X POST "https://api.banking.netevia.dev/netevia/profile/changeBankingStatus?ProfileId=10482&BankingStatus=Approved&Notes=Underwriting+review+complete&NeteviaUserProfileId=201" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
Query Params
int32
string
enum
string
int32
Headers
string
enum
Defaults to application/json

Generated from available response 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