• Register

Account Information Summary

This data feed provides account-level nonmonetary information. There is one AIS record for each account.

Request Body:

Node Child Node Type Length Description Remarks
header msg_id String 12 Unique Source Message ID Mandatory
msg_type String 12 Request Type Default: "TRANSACTION" Mandatory
msg_function String 50 Function name to be used Default:  "REQ_AIS" Mandatory
src_application String 10 Source requesting channel e.g. “IB” or "IVR" etc. Might change. Mandatory
target_application String 10 Target application name Ex. : "WAY4" or "DCMS" or "PCMS" Mandatory
timestamp String 30 Timestamp of the request Format  “DD/MM/YYYY HH:MM:SS” Mandatory
tracking_id String 15 Timestamp of the request Format  “DD/MM/YYYY HH:MM:SS” Mandatory
bank_id String 4 Timestamp of the request Format  “DD/MM/YYYY HH:MM:SS” Mandatory
body tranCode String 3 The action code.
Note: tranCode values must be greater or equal to 100.
Optional
source String 10 Name of source application.
Note: A header accompanies both a message from a sender to a
recipient, and a response from the recipient to the sender. In the
response, the source and dest values are reversed.
Optional
dest String 10 Name of destination application.
Note: A header accompanies both a message from a sender to a
recipient, and a response from the recipient to the sender. In the
response, the source and dest values are reversed.
Optional
extendedHeader String 1024 Extended header. Contains data used by, and returned unaltered to,
the requesting system.
Optional
workflow String 16 Contains the name of the workflow to be executed by Falcon Fraud Manager. Optional
recordType String 8 AIS20 Optional
dataSpecificationVersion String 5 2 Optional
clientIdFromHeader String 16 Unique identifier for the client or subclient.  The value of this field is determined jointly by the client and FICO. Optional
recordCreationDate Date 8 Format: yyyymmdd Optional
Date that this record was created. Time zone must be GMT. Optional
recordCreationTime Date 6 Format: hhmmss Optional
Time that this record was created. Time zone must be GMT. Optional
recordCreationMilliseconds Numeric 3 Format: sss Optional
Milliseconds portion of the time that this record was created.   Optional
gmtOffset Numeric 6 Filled with blanks. Optional
customerIdFromHeader String 20 Primary Customer Identifier.  Financial institution's unique identifier for the primary customer for the account. Optional
customerAcctNumber String 40 Unique identifier for the account associated with the transaction/record. Optional
externalTransactionId String 32 Client-generated unique transaction ID that is unique across all data feeds for a specific installation of Falcon Fraud Manager.  Optional
type String 2 Type of the account. Valid values:
D = DDA/current account
M = Mortgage
H = Home Equity Line of Credit (HELOC)
S = Savings
C = Credit card
LU = Unsecured Loan
LA = Automobile Loan
LS = Secured Loan (other than auto/mortgage)
UC = Unsecured Line of Credit
SC = Secured Line of Credit (other than HELOC)
MM = Money market
T = Treasury
Z = Certificate of deposit
B = Brokerage
O = Other Deposit Accounts (Annuity, Life Insurance, and so on)
Optional
ownership String 2 Indicates what type of legal entity owns the account.  Valid values:
B = Small business
C = Commercial/corporate
G = Government
O = Other
PI = Personal individual
PJ = Personal joint
N = Nonprofit
blank = Unknown
Optional
usage String 2 Indicates the purpose the account is used for. Valid values:
G = General
R = Personal Retirement
E = Escrow
T = Travel and Entertainment
P = Business/Corporate Purchasing
D = Personal/Family Education
H = Personal/Family Healthcare
O = Other
Optional
jointCustomerId String 20 Joint Account Holder Customer Number.  Financial institution's unique identifier for the 2nd customer on a joint account.  Optional
vipType String 1 Very Important Person (VIP) indicator: Optional
S = Standard
V = VIP
routingNumber String 20 Routing number of the financial institution where the customer's account is held. Optional
bankId String 20 Bank Identification Number of the bank or subsidiary that holds the account. Optional
branchId String 20 Branch Identification Number. The ID number for the branch where the account is held. Optional
branchCountry String 3 ISO 3166-1 three-digit numeric country code for the branch where the account is held.  Optional
branchStateProvince String 3 Branch province or state.  Optional
branchCity String 40 Branch city. Optional
branchPostalCode String 10 Branch address: postal code. Optional
applicationReferenceNumber String 32 Unique identifier for the application the customer completed to open the account.  Optional
numberOfPaymentIds Numeric 5 Number of active payment instruments for this account. Optional
numberOfAuthorizedUsers Numeric 5 Number of authorized users on this account.  Optional
openDate Date 8 Format: yyyymmdd Optional
Date the account was originally opened. Optional
status String 2 The account status. For a closed account in which more than one status applies (for example, bankruptcy and charged-off), populate the field with the first applicable value from the following priority list: 22, 24, 23, 28, 21, 25, 29, 20.  Valid values:
00 = Open (more detailed status information is unavailable)
01 = Open, normal, active
02 = Re-opened, normal, active
03 = Open, overlimit/overdraft
04 = Open, interest accrual prohibited
05 = Open, frozen/auth prohibited
06 = Open, disputed
07 = Open, fixed payment (for example, Consumer Credit Counseling Service)
08 = Open, other
11 = Open, normal, inactive
20 = Closed, reason for closure is unavailable
21 = Closed, request from account holder or cardholder
22 = Closed, bankruptcy or filing for bankruptcy
23 = Closed, bank action (revoked)
24 = Closed, charged-off
25 = Closed, fraud
28 = Closed, deceased
29 = Closed, due to inactivity
30 = Closed, account compromise: mass compromise, transacted at compromised POS, phishing victim, and so on
31 = Closed, other
Optional
statusDate Date 8 Format: yyyymmdd Optional
Effective date of current status. Optional
authenticationCodeLength Numeric 2 Reserved. Optional
Length of the authentication code used for the account.  Optional
authenticationCodeSetDate Date 8 Format: yyyymmdd Optional
Reserved. Optional
Date on which the authentication code was last set. Optional
authenticationCodeType String 1 Reserved. Optional
Type of authentication code: Optional
I = Issuer selected Optional
C = Customer selected Optional
Blank = Unknown Optional
currencyCode String 3 ISO 4217 three-digit numeric currency code.  This is the currency unit used for all currency-based fields. Optional
currencyConversionRate Numeric 13 Format: nnnnnn.nnnnnn Optional
The multiplicative currency conversion rate that is used to convert the currency specified in currencyCode to US dollars. The number of US dollars in the currency specified in currencyCode. Optional
creditLimit Numeric 16 Format: nnnnnnnnnnnnnnnn Optional
Credit limit on account and inclusive of all access instruments, expressed in full units of the currency specified in currencyCode.  This is the total of all credit provided by this account.  Optional
overdraftLimit Numeric 16 Format: nnnnnnnnnnnnnnnn Optional
Allowed limit for overdraft, expressed in full units of the currency specified in currencyCode.  Optional
dailyPosLimit Numeric 16 Format: nnnnnnnnnnnnnnnn Optional
Daily limit for POS transactions on account and inclusive of all access instruments, expressed in full units of the currency specified in currencyCode.  Optional
dailyCashLimit Numeric 16 Format: nnnnnnnnnnnnnnnn Optional
Daily limit for cash (ATM) transactions on account and inclusive of all access instruments, expressed in full units of the currency specified in currencyCode.  Optional
dailyTotalLimit Numeric 16 Format: nnnnnnnnnnnnnnnn Optional
Daily limit for all transactions on account and inclusive of all access instruments, expressed in full units of the currency specified in currencyCode.  Optional
cashbackLimitMode String 1 Indicates which daily limits cashback counts towards:
C = Daily CASH limit and, if enforced, daily TOTAL limit
P = Daily POS limit and, if enforced, daily TOTAL limit
T = Daily TOTAL limit only, if enforced
Optional
Optional
Optional
Optional
hasDirectDeposit String 1 Indicates whether there is one or more regular direct deposits into the account:
Y = Yes
N = No
Optional
hasOnlinePay String 1 Indicates whether the account is registered for bill pay or online payment access: Optional
Y = Yes
N = No
hasMobilePay String 1 Indicates whether the account is registered for mobile pay: Optional
Y = Yes
N = No
portfolio String 14 User-defined name of the portfolio to which this account belongs. Optional field.  Optional
accountServiceType String 4 User-defined information (bundles of services and products). Optional
statementAddressee String 60 The addressee of the statement. Optional
statementStreetLine1 String 40 Statement address: Street address line 1. Optional
statementStreetLine2 String 40 Statement address: Street address line 2. Optional
statementStreetLine3 String 40 Statement address: Street address line 3. Optional
statementStreetLine4 String 40 Statement address: Street address line 4. Optional
statementCity String 40 Statement address: city. Optional
statementStateProvince String 3 Statement address: province or state.  Optional
statementPostalCode String 10 Statement address: postal code. Optional
statementCountryCode String 3 Statement address: country.  Optional
statementCyclePeriod Numeric 3 Indicates how often, in number of days, the customer receives an account statement.  Optional
statementDayOfMonth Numeric 2 Day of the month the statement is issued. Optional
interestRate Numeric 8 Reserved. Optional
Effective interest rate on the account.   Optional
interestRateCategory String 10 User-defined classification of the interest rates charged or paid for this account. Optional field.  Optional
numberOfCyclesInactive Numeric 3 Number of cycles the account has been inactive.  Optional
numberOfCyclesDelinquent Numeric 2 Number of cycles delinquent.  Optional
delinquentAmount Numeric 19 Format: nnnnnnnnnnnnnnnn.nn Optional
Total delinquent amount, expressed in units of the currency specified in currencyCode. Optional
overlimitFlag String 1 Overlimit status of the account: Optional
0 = account is not overlimit/overdraft Optional
1 = account is overlimit/overdraft Optional
behaviorScore1 Numeric 4 First behavior score.  Optional
behaviorScore2 Numeric 4 Second behavior score.  Optional
segmentId1 String 6 Segmentation ID of the account. Reserved for FICO modeling. Optional
segmentId2 String 6 Segmentation ID of the account. Reserved for FICO modeling.  Optional
segmentId3 String 6 Segmentation ID of the account. Reserved for FICO modeling.  Optional
segmentId4 String 6 Segmentation ID of the account. Reserved for FICO modeling.  Optional
userIndicator01 String 1 User-defined information. Editable in Falcon Expert rules. Optional
userIndicator02 String 1 User-defined information. Editable in Falcon Expert rules. Optional
userIndicator03 String 1 User-defined information. Editable in Falcon Expert rules. Optional
userIndicator04 String 1 User-defined information. Editable in Falcon Expert rules. Optional
userIndicator05 String 1 User-defined information. Editable in Falcon Expert rules. Optional
userCode1 String 3 User-defined information. Optional
userCode2 String 3 User-defined information. Optional
userCode3 String 3 User-defined information. Optional
userCode4 String 3 User-defined information. Optional
userCode5 String 3 User-defined information. Optional
userData01 String 6 User-defined information. Editable in Falcon Expert rules. Optional
userData02 String 6 User-defined information. Editable in Falcon Expert rules. Optional
userData03 String 6 User-defined information. Editable in Falcon Expert rules. Optional
userData04 String 8 User-defined information. Editable in Falcon Expert rules. Optional
userData05 String 8 User-defined information. Editable in Falcon Expert rules. Optional
userData06 String 8 User-defined information. Editable in Falcon Expert rules. Optional
userData07 String 10 User-defined information. Editable in Falcon Expert rules. Optional
userData08 String 10 User-defined information. Editable in Falcon Expert rules. Optional
userData09 String 15 User-defined information. Editable in Falcon Expert rules. Optional
userData10 String 15 User-defined information. Editable in Falcon Expert rules. Optional
userData11 String 20 User-defined information. Editable in Falcon Expert rules. Optional
userData12 String 20 User-defined information. Editable in Falcon Expert rules. Optional
userData13 String 40 User-defined information. Editable in Falcon Expert rules. Optional
userData14 String 40 User-defined information. Editable in Falcon Expert rules. Optional
userData15 String 60 User-defined information. Editable in Falcon Expert rules. Optional
RESERVED_01 String 30 Reserved.   Optional

Response Body:

Node Child Node   Type  Max Description Remarks
header msg_id  String 12 The msg_id sent in the request will be sent back in response in this field. Mandatory
Unique Source Message ID e.g. “adfasf123456”
msg_type String 12 Request Type Mandatory
msg_function String 50 Function name to be used Mandatory
"REP_AIS"
src_application String 10 The src_application sent in the request will be sent back in response in this field. Mandatory
Source requesting channel e.g. “SSP”
target_application  String 10 The target_application sent in the request will be sent back in response in this field. Mandatory
timestamp String 30 Timestamp of the response Mandatory
Date & time. Format  “DD/MM/YYYY HH:MM:SS”
tracking_id String 15 N/A Optional
bank_id String 4 The bank_id sent in the request will be sent back in response in this field. E.g. ‘XXXX Mandatory
instance_id String 10 N/A Optional
exception_details application_name String 20 Application Name Mandatory
date_time   30 Timestamp of the response Mandatory
String Format “DD/MM/YYYY HH:MM:SS”
status   1 Status of the request (S/F) Mandatory
String Success- S,  Failure - F
error_code String 4 EAI Internal Error Code (Check error codes section for the complete list of error codes and error code descriptions) Mandatory
error_description String 100 Error Description (Check error codes section for the complete list of error codes and error code descriptions) Mandatory
transaction_ref_id String 20 The tracking_id sent in the request will be sent back in response in this field. Optional
body ehError string   hexadecimal value  
workflow string   Workflow code received in original transaction is returned. e.g.
"CREDIT" -- for clients with credit portfolio, and opted for SCORES
"DEBIT" -- for clients with debit portfolio, and opted for SCORES
"RBTRAN" -- for clients with credit portfolio, and opted for SCORES
"modelSTUB" -- Default for RULES ONLY clients
 
cause string   Possible cause for error.
e.g. "Invalid value for recordType"
 
tran_code number 3 nnn - The transaction code.
101 for auth; 102 for advice; 108 for profile maturation
Mandatory
source string 10 Name of source application.

Note: A header accompanies both a message from a sender to a recipient, and a response from the recipient to the sender. In the response, the source and dest values are reversed.
Mandatory
destination string 10 Name of destination application. Mandatory
extended_header string 1024 Extended header. Contains data used by, and returned/unaltered to, the requesting system. For example: Tracking identifier used by requesting system Mandatory
responseRecordVersion String 1 The response_record_version specifies the version of the scoring response
layout. This field is included to support building libraries that support reading
multiple versions of scoring response messages.
Mandatory
scoreCount String 2 This field specifies the number of scores in the response message and has
values from 0 to 8
Mandatory
decisionCount String 2 This field specifies the number of decisions in the response message and has
values from 0 to 10.
Mandatory
scoringServerId String 4 Contains a unique identifier for the Scoring Server host. The default value is
blank. The Scoring Server id is specified during Scoring Server installation and
is meant to be used for high availability configurations (where a scoring request
message is sent to multiple Scoring Servers with the first response received by
the Scoring Server client application (SSCA) being the response that is used by
the client application).
Not Applicable for clients
warning string 50   Optional
Array of decisions (upto 10 Occurences)      
decisions decision_type String 32 Stores the decision type of a type/code pair created by Falcon Expert functions
that generate type/code pairs.
Optional
decision_code String 32 Stores the decision code of a type/code pair created by Falcon Expert functions
that generate type/code pairs.
Optional
Scores Array (up to 8 occurences) -- expected for clients who opted for SCORES as well  
scores score number 4 This is the score returned from the model. Optional
error_code string 4 This is the error code generated by the model during its processing of the transaction to generate a score. A value of 0 or blank indicates no error. Optional
segment_id string 8 This field contains the segment ID of the score in the score_1 field. For segment ID definitions, see the model report for the model that scored the transaction. Optional
score_name string 22 Identifier for the score. The default score names are delivered with the model and can be changed after the model is installed, if needed. Optional
reason1 string 4 This field contains the top reason the score was generated.

For reason-code definitions, see the model report for the model that scored the transaction.
Optional
reason2 string 4 This field contains the second reason the score was generated. Optional
reason3 string 4 This field contains the third reason the score was generated. Optional

Request Json

{
    "NISrvRequest": {
        "request_ais": {
            "header": {
                "msg_id": "223001",
                "msg_type": "TRANSACTION",
                "msg_function": "REQ_FALCON_AIS",
                "src_application": "TIBCO",
                "target_application": "FALCON",
                "timestamp": "2020-07-19T12:59:21.609+04:00",
                "tracking_id": "223001",
                "bank_id": "default",
                "instance_id": "223001"
            },
            "body": {
                "tranCode": "102",
                "source": "TIBCO",
                "dest": "FLACON",
                "extendedHeader": "EXTENDEDHEADER120001",
                "workflow": "modelSTUB",
                "recordType": "AIS20",
                "dataSpecificationVersion": "2.0",
                "clientIdFromHeader": "D360",
                "recordCreationDate": "20230912",
                "recordCreationTime": "160912",
                "recordCreationMilliseconds": "234",
                "gmtOffset": "+03.00",
                "customerIdFromHeader": "12345000000001",
                "customerAcctNumber": "0009991110000000001",
                "externalTransactionId": "D360AIS000000000001",
                "type": "S",
                "ownership": "PI",
                "usage": "G",
                "jointCustomerId": "12345000000101",
                "vipType": "S",
                "routingNumber": "D36000000001",
                "bankId": "999",
                "branchId": "999001",
                "branchCountry": "682",
                "branchStateProvince": "RIY",
                "branchCity": "RIYADH",
                "branchPostalCode": "11564",
                "applicationReferenceNumber": "AIS2000001",
                "numberOfPaymentIds": 2,
                "numberOfAuthorizedUsers": 2,
                "openDate": "20230912",
                "status": "01",
                "statusDate": "20230911",
                "authenticationCodeLength": 20,
                "authenticationCodeSetDate": "20230912",
                "authenticationCodeType": "C",
                "currencyCode": "SAR",
                "currencyConversionRate": "1",
                "creditLimit": 10000000,
                "overdraftLimit": 10000000,
                "dailyPosLimit": 10000000,
                "dailyCashLimit": 10000000,
                "dailyTotalLimit": 10000000,
                "cashbackLimitMode": "C",
                "hasDirectDeposit": "Y",
                "hasOnlinePay": "Y",
                "hasMobilePay": "Y",
                "portfolio": "MOHHEMAD IRFAN",
                "accountServiceType": "0001",
                "statementAddressee": "STATEMENT ADDRESS",
                "statementStreetLine1": "STATEMENT ADDRESS LINE 1",
                "statementStreetLine2": "STATEMENT ADDRESS LINE 2",
                "statementStreetLine3": "STATEMENT ADDRESS LINE 3",
                "statementStreetLine4": "STATEMENT ADDRESS LINE 4",
                "statementCity": "RIYADH",
                "statementStateProvince": "RIY",
                "statementPostalCode": "11564",
                "statementCountryCode": "682",
                "statementCyclePeriod": 1,
                "statementDayOfMonth": 10,
                "interestRate": "10",
                "interestRateCategory": "DELINQ",
                "numberOfCyclesInactive": 1,
                "numberOfCyclesDelinquent": 1,
                "delinquentAmount": 1001,
                "overlimitFlag": "1",
                "behaviorScore1": 202,
                "behaviorScore2": 402,
                "segmentId1": "SEG1",
                "segmentId2": "SEG2",
                "segmentId3": "SEG3",
                "segmentId4": "SEG4",
                "userIndicator01": "A",
                "userIndicator02": "B",
                "userIndicator03": "C",
                "userIndicator04": "D",
                "userIndicator05": "E",
                "userCode1": "UC1",
                "userCode2": "UC2",
                "userCode3": "UC3",
                "userCode4": "UC4",
                "userCode5": "UC5",
                "userData01": "U DAT1",
                "userData02": "U DAT2",
                "userData03": "U DAT3",
                "userData04": "USR DAT4",
                "userData05": "USR DAT5",
                "userData06": "USR DAT6",
                "userData07": "USER DAT07",
                "userData08": "USER DAT08",
                "userData09": "USER DATA 09000",
                "userData10": "USER DATA 10000",
                "userData11": "USER DATA 110000000",
                "userData12": "USER DATA 120000000",
                "userData13": "USER DATA 13000000000000000000000000000X",
                "userData14": "USER DATA 14000000000000000000000000000X",
                "userData15": "USER DATA 1500000000000000000000000000000000000000000000000X",
                "RESERVED_01": "RESERVED_01 00000000000000000X"
            }
        }
    }
}

Response Json

{
    "response_ais": {
        "header": {
            "msg_id": "1694586566",
            "msg_type": "TRANSACTION",
            "msg_function": "REQ_FALCON_AIS",
            "src_application": "TIBCO",
            "target_application": "FALCON",
            "timestamp": "1694586566",
            "tracking_id": "1694586566",
            "bank_id": "default",
            "instance_id": "1694586566"
        },
        "exception_details": {
            "application_name": "",
            "date_time": "2023-09-13T09:29:32.145+03:00",
            "status": "S",
            "error_code": "000",
            "error_description": "Success"
        },
        "body": {
            "tran_code": "102",
            "source": "PMAX",
            "destination": "TIBCO",
            "extended_header": "EXTENDEDHEADER120001",
            "responseRecordVersion": "4",
            "scoreCount": "00",
            "decisionCount": "0"
        }
    }
}

Docs Navigation