Skip to main content

Attributes reference

You use our Open Banking Hub to to share bank account information securely and electronically for bank account verification, affordability checking and identification purposes.

This page summarises attributes and sample requests and responses for performing an AIS (Account Information Service) process to retrieve bank account holder information and then comparing it with the information you provided.

Bank Account Verification​

Request attributes​

To create a session, you must specify the required fields from the table below in the initial request:

Example create session request​

{
  "flow": "redirect",
  "prefilledInput": {
      "firstName": "Max",
      "lastName": "Mustermann",
      "bankAccountNumber": "AT930000098385727264"
    },
  "additionalParameters": {
    "open_banking_method": "bank-account-verification"
  },
  "callbackUrls": {
    "success": "https://example.com/callbacks/success",
    "abort": "https://example.com/callbacks/abort",
    "error": "https://example.com/callbacks/error"
  },
  "requestedAttributes": [
    "bankAccountVerificationIban",
    "bankAccountVerificationCorroborationScore",
    "bankAccountVerification.corroboration.accountInformation.holderName.firstName.result",
    "bankAccountVerification.corroboration.accountInformation.holderName.firstName.actual",
    "bankAccountVerification.corroboration.accountInformation.holderName.firstName.expected",
    "bankAccountVerification.corroboration.accountInformation.holderName.firstName.score",
    "bankAccountVerification.corroboration.accountInformation.holderName.firstName.numberOfCharactersMismatched",
    "bankAccountVerification.corroboration.accountInformation.holderName.lastName.result",
    "bankAccountVerification.corroboration.accountInformation.holderName.lastName.actual",
    "bankAccountVerification.corroboration.accountInformation.holderName.lastName.expected",
    "bankAccountVerification.corroboration.accountInformation.holderName.lastName.score",
    "bankAccountVerification.corroboration.accountInformation.holderName.lastName.numberOfCharactersMismatched",
    "bankAccountVerification.corroboration.accountInformation.account.bankAccountNumber.result",
    "bankAccountVerification.corroboration.accountInformation.account.bankAccountNumber.actual",
    "bankAccountVerification.corroboration.accountInformation.account.bankAccountNumber.expected"
    ]
}

Response attributes​

Important

The asterisk (*) in the attribute names in the table below represents bankAccountVerification.corroboration.accountInformation.

Example response​

{
    "id": "00000000-0000-0000-0000-000000000000",
    "accountId": "a-some-accountId",
    "authenticationUrl": "https://foobar.sandbox.signicat.com/broker/sp/external-service/login?messageId=ffffffff-ffff-4fff-bfff-ffffffffffff&transactionId=00000000-0000-0000-0000-000000000000",
    "status": "SUCCESS",
    "provider": "global-solutions",
    "subject": {
        "id": "qwerty",
        "idpId": "asdf",
        "bankAccountVerification.corroboration.accountInformation.holderName.firstName.result": "success",
        "bankAccountVerification.corroboration.accountInformation.holderName.firstName.actual": "MAX",
        "bankAccountVerification.corroboration.accountInformation.holderName.firstName.expected": "MAX",
        "bankAccountVerification.corroboration.accountInformation.holderName.firstName.score": "100",
        "bankAccountVerification.corroboration.accountInformation.holderName.firstName.numberOfCharactersMismatched": "0",
        "bankAccountVerification.corroboration.accountInformation.holderName.lastName.result": "success",
        "bankAccountVerification.corroboration.accountInformation.holderName.lastName.actual": "MUSTERMANN",
        "bankAccountVerification.corroboration.accountInformation.holderName.lastName.expected": "MUSTERMANN",
        "bankAccountVerification.corroboration.accountInformation.holderName.lastName.score": "100",
        "bankAccountVerification.corroboration.accountInformation.holderName.lastName.numberOfCharactersMismatched": "0",
        "bankAccountVerification.corroboration.accountInformation.account.bankAccountNumber.result": "success",
        "bankAccountVerification.corroboration.accountInformation.account.bankAccountNumber.actual": "AT930000098385727264",
        "bankAccountVerification.corroboration.accountInformation.account.bankAccountNumber.expected": "AT930000098385727264",
        "bankAccountVerificationCorroborationScore": "100",
        "bankAccountVerificationIban": "AT930000098385727264"
    },
    "callbackUrls": {
         "success": "https://example.com:443/callbacks/success?sessionId=00000000-0000-0000-0000-000000000000",
         "abort": "https://example.com:443/callbacks/abort?sessionId=00000000-0000-0000-0000-000000000000",
         "error": "https://example.com:443/callbacks/error?sessionId=00000000-0000-0000-0000-000000000000"
    },
    "environment": {
        "ipAddress": "203.0.113.1",
        "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko)"
    },
    "allowedProviders": [],
    "flow": "redirect",
    "requestedAttributes": [
        "bankAccountVerification.corroboration.accountInformation.account.bankAccountNumber.actual",
        "bankAccountVerification.corroboration.accountInformation.account.bankAccountNumber.expected",
        "bankAccountVerification.corroboration.accountInformation.account.bankAccountNumber.result",
        "bankAccountVerification.corroboration.accountInformation.holderName.firstName.actual",
        "bankAccountVerification.corroboration.accountInformation.holderName.firstName.expected",
        "bankAccountVerification.corroboration.accountInformation.holderName.firstName.numberOfCharactersMismatched",
        "bankAccountVerification.corroboration.accountInformation.holderName.firstName.result",
        "bankAccountVerification.corroboration.accountInformation.holderName.firstName.score",
        "bankAccountVerification.corroboration.accountInformation.holderName.lastName.actual",
        "bankAccountVerification.corroboration.accountInformation.holderName.lastName.expected",
        "bankAccountVerification.corroboration.accountInformation.holderName.lastName.numberOfCharactersMismatched",
        "bankAccountVerification.corroboration.accountInformation.holderName.lastName.result",
        "bankAccountVerification.corroboration.accountInformation.holderName.lastName.score",
        "bankAccountVerificationCorroborationScore",
        "bankAccountVerificationIban",
        "idpId"
    ],
    "sessionLifetime": 1200,
    "expiresAt": "2024-06-11T14:23:28.8147885+00:00"
}

Affordability Check​

Our Affordability Check feature is coming soon.

Identity Verification​

Our Identity Verification feature is coming soon.

Last updated:
On this page