Sending a verification code

API Method: POST /api/CodeVerification/send

Action: Send Verification Code

Description:

This API method initiates the process of sending a verification code (typically via SMS or email) to a user for the purpose of confirming or authorizing a specific action within the banking application. The type of action is specified via the shortMessageType parameter, which determines the context and reason for the code being sent.

Endpoint:

POST https://api.banking.netevia.dev/api/CodeVerification/send

Functionality:

• Purpose: To trigger a verification code message for sensitive or security-related actions, such as login attempts, approving transactions, password resets, or account updates.
• Use Case: Enhances security by requiring user verification for key actions through two-factor authentication (2FA) mechanisms.

Request Headers:

• Authorization: Bearer token (if required by context)
• Content-Type: application/json

Request Body:

Accepted Values for shortMessageType:

• UNKNOWN: Unspecified or default type.
• APPROVE_TRANSACTION: Approval required for a financial transaction.
• APPROVE_PAYEE: Approval for adding or modifying a payee.
• ApproveLinkedAccount: Approval to link an external account.
• RestorePassword: Verification for password reset.
• AttemptLogin: Verification for login attempt.
• TransferPoints: Authorization to transfer reward/loyalty points.
• SetEwaRequest: Approval for an Earned Wage Access (EWA) request.
• ContactInfoUpdateRequest: Verification for updating contact information.

Example Request:

{
  "shortMessageType": "APPROVE_TRANSACTION"
}

Example Response:

{
  "status": "success",
  "message": "Verification code sent successfully."
}

Response Codes:

• 200 OK: Code was successfully generated and sent.
• 400 Bad Request: Missing or invalid shortMessageType value.
• 401 Unauthorized: Authentication failed or missing token.
• 429 Too Many Requests: Rate limit exceeded for code requests.
• 500 Internal Server Error: An error occurred while processing the request.

Notes:

• Security: The system typically uses SMS, email, or in-app messaging to deliver the verification code.
• Rate Limiting: Multiple code requests in a short period may be throttled to prevent abuse.
• Follow-Up: The code sent via this method is usually required in a subsequent endpoint for confirmation, such as /api/CodeVerification/check.

This method is a critical part of securing user actions and enhancing trust in the banking platform.