Restore login by email

Restore Login by Email

This endpoint enables users to restore their login access by submitting their email address along with a partner code. Upon a successful request, the system sends password reset instructions to the provided email. No authentication token is required to call this endpoint, making it accessible to users who have lost access to their credentials.

Endpoint

POST /v2/restoreLogin

Authentication

No authentication required for this endpoint. It is publicly accessible to support unauthenticated password recovery flows.

For all other Netevia API endpoints, obtain a Bearer token 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 a user has forgotten their credentials and needs to regain access to their Netevia account. It is typically triggered from a "Forgot Password" or "Restore Login" UI flow within a partner application. The endpoint sends an email to the registered address with steps to complete the login restoration.

Request Body

FieldTypeRequiredDescription
codestringYesPartner or verification code associated with the login restoration request. Minimum length: 1.
emailstring (email)YesThe registered email address of the user requesting login restoration. Minimum length: 1.
{
  "code": "PARTNER_CODE_123",
  "email": "[email protected]"
}

Response

200 OK

FieldTypeDescription
restoreStatestring (nullable)Indicates the current state of the restore process (e.g., email sent, pending, completed).
errorsarray of strings (nullable)List of error messages if the restoration request could not be processed.
successstring (nullable)Confirmation message when the restoration email was sent successfully.
{
  "restoreState": "EmailSent",
  "errors": null,
  "success": "Password reset instructions have been sent to the provided email address."
}

Error Codes

CodeWhen it happens
400Missing required fields (code or email), invalid email format, or validation error
404No account found associated with the provided email address
500Internal server error during email dispatch or restoration processing

Common Mistakes

  • Omitting the code field — both code and email are required; sending only the email will result in a 400 error.
  • Submitting an improperly formatted email address — the email field must conform to standard email format (e.g., [email protected]).
  • Assuming a 200 response means the email was delivered — always inspect the errors array and restoreState field to confirm the request was processed successfully.
  • Calling this endpoint with an Authorization header is unnecessary and should be avoided for this public endpoint.

Related Endpoints

  • POST /api/auth/v2 — Obtain a Bearer token using username, password, and partnerId
  • POST /api/auth/refresh — Refresh an existing Bearer token before it expires

Example

curl -X POST https://api.banking.netevia.dev/v2/restoreLogin \
  -H "Content-Type: application/json" \
  -d '{
    "code": "PARTNER_CODE_123",
    "email": "[email protected]"
  }'
Body Params
string
required
length ≥ 1
string
required
length ≥ 1
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

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