Skip to main content

Validate

POST 
/api/Users/Validate

Description​

Validate a user’s session to ensure it is still active and valid. It is used to verify the authenticity of a session or token during ongoing interactions with the system. It also returns a new access token, refresh token and expiration date-time.

Request​

Body Parameters

    ActionLog object
    Action string
    Controller string
    Date date-time
    DeviceId string
    Id integer
    IpAddress string
    LanguageCode string
    LoginKey string
    Username string
    ForceLoad boolean
    LogInfo object
    AppVersion string
    IpAddress string
    LanguageCode string
    Validation objectrequiredThe validation parameter, mandatory to all Banking Suite API calls.
    AccessToken string

    The access token for authentication.

    AppKey string

    The key assigned to the application.

    CustomerCode string

    The unique code assigned to the customer.

    DeviceId string

    The unique identifier of the device.

    LoginKey string

    The key used for login.

    RefreshToken string

    The token used to refresh the session.

    Username string

    The username for authentication.

Responses​

Success
Schema
    commandToken string
    customerCode string
    date date-time
    devicesList object[]
  • Array [
    • blocked boolean
    currentVersion string

    Possible values: <= 20 characters

    dateCreated date-time
    dateUpdated date-time
    deviceDetails string

    Possible values: <= 100 characters

    deviceID string

    Possible values: non-empty and <= 70 characters

    deviceName string

    Possible values: <= 50 characters

    enabled boolean
    id int32
    lastAction date-time
    loginKey string

    Possible values: <= 70 characters

    username string

    Possible values: non-empty and <= 256 characters

  • ]
    • httpStatusCode int32

    Possible values: [100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 306, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, 511]


    Description: 100 = "Continue", 101 = "SwitchingProtocols", 102 = "Processing", 103 = "EarlyHints", 200 = "OK", 201 = "Created", 202 = "Accepted", 203 = "NonAuthoritativeInformation", 204 = "NoContent", 205 = "ResetContent", 206 = "PartialContent", 207 = "MultiStatus", 208 = "AlreadyReported", 226 = "IMUsed", 300 = "Ambiguous", 300 = "Ambiguous", 301 = "Moved", 301 = "Moved", 302 = "Redirect", 302 = "Redirect", 303 = "RedirectMethod", 303 = "RedirectMethod", 304 = "NotModified", 305 = "UseProxy", 306 = "Unused", 307 = "TemporaryRedirect", 307 = "TemporaryRedirect", 308 = "PermanentRedirect", 400 = "BadRequest", 401 = "Unauthorized", 402 = "PaymentRequired", 403 = "Forbidden", 404 = "NotFound", 405 = "MethodNotAllowed", 406 = "NotAcceptable", 407 = "ProxyAuthenticationRequired", 408 = "RequestTimeout", 409 = "Conflict", 410 = "Gone", 411 = "LengthRequired", 412 = "PreconditionFailed", 413 = "RequestEntityTooLarge", 414 = "RequestUriTooLong", 415 = "UnsupportedMediaType", 416 = "RequestedRangeNotSatisfiable", 417 = "ExpectationFailed", 421 = "MisdirectedRequest", 422 = "UnprocessableEntity", 423 = "Locked", 424 = "FailedDependency", 426 = "UpgradeRequired", 428 = "PreconditionRequired", 429 = "TooManyRequests", 431 = "RequestHeaderFieldsTooLarge", 451 = "UnavailableForLegalReasons", 500 = "InternalServerError", 501 = "NotImplemented", 502 = "BadGateway", 503 = "ServiceUnavailable", 504 = "GatewayTimeout", 505 = "HttpVersionNotSupported", 506 = "VariantAlsoNegotiates", 507 = "InsufficientStorage", 508 = "LoopDetected", 510 = "NotExtended", 511 = "NetworkAuthenticationRequired"

    logginsList object[]
  • Array [
    • date date-time
    ip string
    success boolean
  • ]
    • message string
    newAccessToken string
    newRefreshToken string
    pendingTransactions object[]
  • Array [
    • additionalInfo string
    amount double
    charges double
    creditorAccountIban string
    creditorAccountNumber string
    creditorName string
    currency int32

    Possible values: [0, 1, 2, 3]


    Description: 0 = "Undefined", 1 = "EUR", 2 = "USD", 3 = "GBP"

    date date-time
    debtorAccountIban string
    debtorAccountNumber string
    debtorName string
    description string
    referenceDate date-time
    requires3FA boolean
    transactionCode string
    transactionType int32

    Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19]


    Description: 0 = "Unknown", 1 = "TransferToMyAccount", 2 = "TransferToThirdParty", 3 = "TransferToOtherBank", 4 = "BillPayment", 5 = "CreditCardPayment", 6 = "DirectDebit", 7 = "IrisTransfer", 8 = "Card_GetPin", 9 = "Card_ChangePin", 10 = "Card_UnblockPin", 11 = "Card_GetECommercePin", 12 = "Card_ChangeECommercePin", 13 = "Card_ChangeAllowedOperations", 14 = "Card_ChangeLimits", 15 = "Card_ChangeStatus", 16 = "Card_GetSensitiveInformation", 17 = "Card_SetCVV", 18 = "Card_ReIssue", 19 = "Card_ChangeAlias"

    userHasActive3FAPassword boolean
  • ]
    • requiredVersion int32
    status int32

    Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14]


    Description: 0 = "UNKNOWN", 1 = "OK", 2 = "FAIL", 3 = "UNAUTHORIZED", 4 = "PASSWORD_EXPIRED", 5 = "DISABLED", 6 = "BLOCKED", 7 = "TIME_OUT", 8 = "NO_INTERNET", 9 = "INVALID_ACCOUNT", 10 = "REQUIRE_UPDATE", 11 = "SYSTEM_DOWN", 12 = "PENDING_COMMAND", 13 = "PENDING_LOGIN", 14 = "REGISTERED"

    verificationTimeSeconds int32
    webUser object
    accessToken string
    behavAuth object
    apiKey string
    isAvailable boolean
    userVerificationSecret string
    customerCode string
    email string
    favoriteOperationsJson string
    fullname string
    hasPendingPolicies boolean
    homeViewsJson string
    id string
    pendingPolicies object[]
  • Array [
    • code string
    hasAccepted boolean
    id int32
    language string
    order int32
    text string
    title string
  • ]
    • phone string
    photo byte
    refreshToken string
    roles int32[]

    Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46]

    userPreferencesJson string
    userSettings object
    consents object[]
  • Array [
    • channel string
    consentCode string
    dateAccepted date-time
    hasAcknowledged boolean
  • ]
    • policies object[]
  • Array [
    • channel string
    dateAccepted date-time
    hasAcknowledged boolean
    policyTextCode string
  • ]
    • properties object
    allowTransfersAbroad boolean
    isFreeLancer boolean
    isIndividual boolean
    isLegalEntity boolean
    isOnboardCompleted boolean
    username string
Loading...