Sign In

Sign In

POST {{Environment_URL}}/v1/heimdall/account/signin

This endpoint authenticates a user using their email and password and returns an access token. When the credentials are valid, the API responds with:

• A token that must be used in authenticated requests.

• The user’s roles and permissions.

• Information about the linked agent and default account.

If the credentials are invalid, the API returns an error indicating that the email or password is incorrect. Use this endpoint as the first step before calling any protected routes in the API.

Headers

No Headers

Body

The following parameters are needed for authentication:

Key	Description	Required?	Data ype	Example
email	Defined email	true	String	[email protected]
password	Defined password	true	String	MyPass@1234

Request

Sign-In

{
  "email": "[email protected]",
  "password": "MyPass@1234"
}

Response

200 - OK

{
    "token": "{{token}}",
    "data": {
        "permissions": [
            "GET_QUOTATION",
            "CREATE_CHARGE"
        ],
        "roles": [
            "SIMPLE_PAY_VENDOR"
        ],
        "agent": {
            "id": 1,
            "account_default_alias": "84cd5a2c-8f97-4793-9c43-ae224e59d602",
            "beneficiary": "Gorczany - Koelpin",
            "account_id": "1e9243be-667b-40cb-a274-d873f95368e3"
        }
    }
}

400 - Bad Request