Login

GET /api/v1/BankStatement/login

Description

This endpoint is used to login to a financial institution for bank statement verification.

Headers: Accept-Language: optional, allows changing default response message language, type: string

Content-Type:

• text/plain
• application/json
• text/json

ApiKey:

• No API key required

Request Body:

• Type: JSON object
• Schema: $ref to LoginToFinancialInstitutionCommand schema

URL: /api/v1/BankStatement/login

Query Parameters:

• None

params:

• Not applicable

Response: The response is a "Success" status with a code of 200.

Schema:

    jsonCopy code{
    "sessionId": "example_session_id"
    }

Error Codes:

• 400: Bad Request
• 404: Resource not found
• 500: Internal server error

Example:

    bashCopy codePOST /api/v1/BankStatement/login
    {
    "username": "john_doe",
    "password": "example123"
    }

Response:

    jsonCopy codeHTTP/1.1 200 OK
    {
    "sessionId": "new_example_session_id"
    }

Headers

---

Accept-Language Change default response message language from English(en). Available languages fr,en Content-Type application/json

Accept text/plain

Body raw(json)

    {
    "credentials": {
        "username": "<string>",
        "password": "<string>"
    },
    "sessionId": "<string>"
    }