Falcon services are offered for payment card fraud detection. This section will provide more details about Individual services.

Version

Account Information Summary

Status:

Production

Version:

V2

Category:

FalconServices

Overview

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

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

Account Information Summary

Status:

Production

Version:

V2

Category:

FalconServices
/falconservices/transaction/v2/ais
curl --location --request POST '#{PARAM_URL}' --header 'Authorization: Bearer {{ access_token }}' {custom_headers} --data-raw '#{JSON_PAYLOAD}'
curl --location --request GET 'https://api-sandbox.network.global/v1/tokenkc/generate' \--data-raw '#{JSON_PAYLOAD}'
curl --location --request POST 'https://api-sandbox.network.global/v1/tokenkc/generate' \--data-raw '#{JSON_PAYLOAD}'

Node Child Node Type Length Description
Authorization* requiredBearer xxxx* requiredstringAuthorization Header (Bearer Token)
Content-Type* requiredapplication/json* requiredstringContent Type

Node TypeTypeLengthDescription
NISrvRequestrequest_aisheadermsg_id* requiredstring12Message ID, this field should be unique id for each Api call. This will be generated from client side. If the same message ID is used the system will decline the API call with Error Description “Duplicate Message ID”
msg_type* requiredstring12Message Type – This can have either “TRANSACTION” or “ENQUIRY” As for this API the value expected is “TRANSACTION”
msg_function* requiredstring50Message functions: Should be “REP_FALCON_AIS”
src_application* requiredstring10Source Application: This is a free Text and the client can populate the source system from where the API is Initiated Example: TIBCO, IB, MB No Validations of these are kept at Network Systems
target_application* requiredstring10The target_application can hold any value from FI side, this can be used by FI to check the target system of the API call
timestamp* requiredstring30Timestamp of the request - Format YYYY-MM-DDtHH:MM:SS.SS +04:00
bank_id* requiredstring4Bank Id is Unique Id 4 digit code for each client and the same will be provided once the client setup is completed in our core system. For sandbox testing – Please use “NIC”
bodytranCodestring3The action code. Note tranCode values must be greater or equal to 100.
sourcestring10Name 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.
deststring10Name 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.
extendedHeaderstring1024Extended header. Contains data used by, and returned unaltered to, the requesting system.
workflowstring16Contains the name of the workflow to be executed by Falcon Fraud Manager.
recordTypestring8AIS20.
dataSpecificationVersionstring5the value 2 should be added
clientIdFromHeaderstring16Unique identifier for the client or subclient. The value of this field is determined jointly by the client and FICO.
recordCreationDatestring8format yyyymmdd Date that this record was created. Time zone must be GMT.
recordCreationTimestring6format hhmmss Time that this record was created. Time zone must be GMT.
recordCreationMillisecondsstring3format sss Milliseconds portion of the time that this record was created.
gmtOffsetstring6Filled with blanks.
customerIdFromHeaderstring20Primary Customer Identifier. Financial institution's unique identifier for the primary customer for the account.
customerAcctNumberstring40Unique identifier for the account associated with the transaction/record.
externalTransactionIdstring32Client-generated unique transaction ID that is unique across all data feeds for a specific installation of Falcon Fraud Manager.
typestring2Type 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).
ownershipstring2Indicates 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.
usagestring2Indicates 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
jointCustomerIdstring20Joint Account Holder Customer Number. Financial institution's unique identifier for the 2nd customer on a joint account.
vipTypestring1Very Important Person (VIP) indicator S=Standard V=VIP
routingNumberstring20Routing number of the financial institution where the customer's account is held.
bankIdstring20Bank Identification Number of the bank or subsidiary that holds the account.
branchIdstring20Branch Identification Number. The ID number for the branch where the account is held.
branchCountrystring3ISO 3166-1 three-digit numeric country code for the branch where the account is held.
branchStateProvincestring3Branch province or state.
branchCitystring40Branch City
branchPostalCodestring10Branch address postal code.
applicationReferenceNumberstring32Unique identifier for the application the customer completed to open the account.
numberOfPaymentIdsstring5Number of active payment instruments for this account.
numberOfAuthorizedUsersstring5Number of authorized users on this account.
openDatestring8Format yyyymmdd Date the account was originally opened.
statusstring2The 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
statusDatestring8Format yyyymmdd Date the account was originally opened.
authenticationCodeLengthstring2Length of the authentication code used for the account.
authenticationCodeSetDatestring8Date on which the authentication code was last set Format yyyymmdd
authenticationCodeTypestring1Type of authentication code I = Issuer selected C = Customer selected Blank = Unknown
currencyCodestring3ISO 4217 three-digit numeric currency code. This is the currency unit used for all currency-based fields.
currencyConversionRatestring13The 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. Format nnnnnn.nnnnnn
creditLimitstring16Credit 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.
overdraftLimitstring16Daily limit for POS transactions on account and inclusive of all access instruments, expressed in full units of the currency specified in currencyCode.
dailyCashLimitstring16Daily limit for cash (ATM) transactions on account and inclusive of all access instruments, expressed in full units of the currency specified in currencyCode.
dailyTotalLimitstring16Daily limit for all transactions on account and inclusive of all access instruments, expressed in full units of the currency specified in currencyCode.
cashbackLimitModestring1Indicates 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
hasDirectDepositstring1Indicates whether there is one or more regular direct deposits into the account Y = Yes N = No
hasOnlinePaystring1Indicates whether the account is registered for bill pay or online payment access Y = Yes N = No
hasMobilePaystring1Indicates whether the account is registered for mobile pay Y = Yes N = No
portfoliostring14User-defined name of the portfolio to which this account belongs.
accountServiceTypestring4User-defined information (bundles of services and products).
statementAddresseestring60The addressee of the statement.
statementStreetLine1string40Statement address: Street address line 1.
statementStreetLine2string40Statement address: Street address line 2.
statementStreetLine3string40Statement address: Street address line 3.
statementStreetLine4string40Statement address: Street address line 4.
statementCitystring40Statement address city
statementStateProvincestring3Statement address province or state.
statementPostalCodestring10Statement address postal code.
statementCountryCodestring3Statement address country code.
statementCyclePeriodstring3Indicates how often, in number of days, the customer receives an account statement.
statementDayOfMonthstring2Day of the month the statement is issued.
interestRatestring8Effective interest rate on the account.
interestRateCategorystring10User-defined classification of the interest rates charged or paid for this account.
numberOfCyclesInactivestring3Number of cycles the account has been inactive.
numberOfCyclesDelinquentstring2Number of cycles delinquent.
delinquentAmountstring19Total delinquent amount, expressed in units of the currency specified in currencyCode.
overlimitFlagstring1Overlimit status of the account 0 = account is not overlimit/overdraft 1 = account is overlimit/overdraft
behaviorScore1string4First behavior score.
behaviorScore2string4Second behavior score.
segmentId1string6Segmentation ID of the account. Reserved for FICO modeling.
segmentId2string6Segmentation ID of the account. Reserved for FICO modeling.
segmentId3string6Segmentation ID of the account. Reserved for FICO modeling.
segmentId4string6Segmentation ID of the account. Reserved for FICO modeling.
userIndicator01string1User-defined information. Editable in Falcon Expert rules
userIndicator02string1User-defined information. Editable in Falcon Expert rules
userIndicator03string1User-defined information. Editable in Falcon Expert rules
userIndicator04string1User-defined information. Editable in Falcon Expert rules
userIndicator05string1User-defined information. Editable in Falcon Expert rules
userCode1string6User-defined information.
userCode2string6User-defined information.
userCode3string6User-defined information.
userCode4string8User-defined information.
userCode5string8User-defined information.
userData01string6User-defined information.Editable in Falcon Expert rules.
userData02string6User-defined information.Editable in Falcon Expert rules.
userData03string6User-defined information.Editable in Falcon Expert rules.
userData04string8User-defined information. Editable in Falcon Expert rules.
userData05string8User-defined information.Editable in Falcon Expert rules.
userData06string8User-defined information.Editable in Falcon Expert rules.
userData07string10User-defined information.Editable in Falcon Expert rules.
userData08string10User-defined information.Editable in Falcon Expert rules.
userData09string15User-defined information.Editable in Falcon Expert rules.
userData10string15User-defined information.Editable in Falcon Expert rules.
userData11string20User-defined information.Editable in Falcon Expert rules.
userData12string20User-defined information.Editable in Falcon Expert rules.
userData13string40User-defined information.Editable in Falcon Expert rules.
userData14string40User-defined information.Editable in Falcon Expert rules.
userData15string60User-defined information.Editable in Falcon Expert rules.
RESERVED_01string30Reserved

{
    "NISrvRequest": {
        "request_ais": {
            "header": {
                "msg_id": "236001",
                "msg_type": "TRANSACTION",
                "msg_function": "REP_FALCON_AIS",
                "src_application": "TIBCO",
                "target_application": "FALCON",
                "timestamp": "2020-07-20T10:49:02.366+04:00",
                "bank_id": "default"
            },
            "body": {
                "tranCode": "102",
                "source": "TIBCO",
                "dest": "FALCON",
                "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",
                "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": "SEG3",
                "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"
            }
        }
    }
}

Node Child Node Type Length Description
Content-Typeapplication/jsonstringContent Type

Node TypeTypeLengthDescription
NISrvResponseresponse_aisheadermsg_id* requiredstring12Message ID, this field should be unique id for each Api call. This will be generated from client side. If the same message ID is used the system will decline the API call with Error Description “Duplicate Message ID”
msg_type* requiredstring12Message Type – This can have either “TRANSACTION” or “ENQUIRY” As for this API the value expected is “TRANSACTION”
msg_function* requiredstring50Message functions: Should be “REP_AIS”
src_application* requiredstring10Source Application: This is a free Text and the client can populate the source system from where the API is Initiated Example: TIBCO, IB, MB No Validations of these are kept at Network Systems
target_application* requiredstring10The target_application can hold any value from FI side, this can be used by FI to check the target system of the API call
timestamp* requiredstring15Timestamp of the response - Format YYYY-MM-DDtHH:MM:SS.SSS+04:00
bank_id* requiredstring4Bank Id is Unique Id 4 digit code for each client and the same will be provided once the client setup is completed in our core system. For sandbox testing – Please use “NIC”
exception_detailsapplication_name* requiredstring20Application Name
date_time* requiredstring30Timestamp of the response Format “YYYY-MM-DD HH:MM:SS”
status* requiredstring1Status of the request (S/F)
error_code* requiredstring4EAI Internal Error Code (Check error codes section for the complete list of error codes and error code descriptions)
error_description* requiredstring100Error Description (Check error codes section for the complete list of error codes and error code descriptions)
transaction_ref_idstring20The tracking_id sent in the request will be sent back in response in this field.
bodytran_code* requirednumber3The transaction code. 101 for auth, 102 for advice, 108 for profile maturation.
source* requiredstring10Name 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 destination values are reversed.
destination* requiredstring10Name of destination application.
extended_header* requiredstring1024Extended header. Contains data used by, and returned/unaltered to, the requesting system. For example: Tracking identifier used by requesting system.
responseRecordVersion* requiredstring1The 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.
scoreCount* requiredstring2This field specifies the number of scores in the response message and has values from 0 to 8.
decisionCount* requiredstring2This field specifies the number of decisions in the response message and has values from 0 to 10.

{
    "NISrvResponse": {
        "response_ais": {
            "header": {
                "msg_id": "236001",
                "msg_type": "TRANSACTION",
                "msg_function": "REP_FALCON_AIS",
                "src_application": "TIBCO",
                "target_application": "FALCON",
                "timestamp": "2020-07-20T06:49:02.366Z",
                "bank_id": "default"
            },
            "exception_details": {
                "application_name": "TCC-ADP",
                "date_time": "2023-02-01T16:39:47.314+04:00",
                "status": "S",
                "error_code": "000",
                "error_description": "Success",
                "transaction_ref_id": "236001"
            },
            "body": {
                "tran_code": 101,
                "source": "PMAX",
                "destination": "TIBCO",
                "extended_header": "EXTENDEDHEADER120001",
                "responseRecordVersion": "4",
                "scoreCount": "00",
                "decisionCount": "0"
            }
        }
    }
}

Code Description
200Sample Description
400Bad Request
401Unauthorized
403Forbidden
500Internal Server Error
502Bad gateway
503Scheduled Maintenance
504Gateway Timeout
596Service Not Found

How It Works

Follow the steps below. For more details, read the Quick Start Guide.