Falcon services

Overview

Falcon services provide a comprehensive suite of fraud detection capabilities focused on monitoring and protecting payment card transactions and account activities. The system handles both monetary and nonmonetary data streams, combining account, customer, and transaction-level information to maintain a robust fraud detection framework.

Real-Time Authorization Engine

Instant transaction validation and decision-making for both credit and debit card purchases at point of sale.

Multi-Level Data Intelligence

Unified processing of account, customer, and card information for comprehensive fraud detection.

Dynamic Profile Management

Real-time updates and monitoring of customer profiles, travel notifications, and account changes.

 

 

Version

Customer Information Summary

Status:

Production

Version:

V2

Product:

FalconServices

Overview

This record provides customer-level nonmonetary information, such as mailing address, telephone number, and relationship with the financial institution. There is one CIS record for each account.

https://api-sandbox.network.global

Customer Information Summary

Status:

Production

Version:

V2

Product:

FalconServices
/falconservices/transaction/v2/cis
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_CISheadermsg_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 “REQ_FALCON_CIS”
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.
recordTypestring8CIS20.
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.
customerTypestring1Reserved. Type of entity providing application. I = Individual M = Individual minor B = Small business C = Corporation G = Government O = Other
vipTypestring1Very Important Person (VIP) indicator S=Standard V=VIP
relationshipStartDatestring8Date of first business relationship with the customer.
numberOfAccountsstring5Total number of open accounts linked to this customer, regardless of account type.
givenNamestring30Given name of the customer. In the United States, this is the first name.
middleNamestring30Middle name of the customer.
surnamestring60Surname of the customer. In the United States, this is last name.
titlestring10Name prefix (for example, Mr., Mrs., Dr.).
suffixstring10Name suffix of the customer (for example, Sr., Jr., III.).
preferredGreetingstring60Preferred way to greet the customer in communications (for example, Mr. John Smith, Ms. Davis).
preferredLanguagestring3Preferred customer language. This is typically a 2 or 3 character language code.
mothersMaidenNamestring60Maiden name of customer's mother.
householdNamestring60Reserved for future use. Family name of owner of the residence where the customer lives.
streetLine1string40Primary address: Street address line 1.
streetLine2string40Primary address: Street address line 2.
streetLine3string40Primary address: Street address line 3.
streetLine4string40Primary address: Street address line 4.
citystring40Branch City
stateProvincestring3Primary address: province or state.
postalCodestring10Primary address: postal code.
countryCodestring3Primary address: country.
residenceStatusstring1Residence status: - O = Owns residence - R = Rents - F = Family owned - E = Employer provided - S = University/college/school - T = Other - U = Unknown
dateAtAddressstring8Start date at current address. Format: yyyymmdd.
secondaryAddrTypestring1Secondary address type: - M = Mailing address - P = Post office box - O = Other classification - U = Unknown
secondaryAddrStreetLine1string40Secondary address: Street address line 1.
secondaryAddrStreetLine2string40Secondary address: Street address line 2.
secondaryAddrStreetLine3string40Secondary address: Street address line 3.
secondaryAddrStreetLine4string40Secondary address: Street address line 4.
secondaryAddrCitystring40Secondary address: city.
secondaryAddrStateProvincestring3Secondary address: province or state.
secondaryAddrPostalCodestring10Secondary address: postal code.
secondaryAddrCountryCodestring3Secondary address: country.
employerstring60Name of customer's employer.
workAddrStreetLine1string40Work address: Street address line 1.
workAddrStreetLine2string40Work address: Street address line 2.
workAddrStreetLine3string40Work address: Street address line 3.
workAddrStreetLine4string40Work address: Street address line 4.
workAddrCitystring40Work address: city.
workAddrStateProvincestring3Work address: province or state.
workAddrPostalCodestring10Work address: postal code.
workAddrCountryCodestring3Work address: country.
employmentStatusstring3Employment status: - 400 = Private sector - 410 = Government sector - 420 = Business owner - 500 = Retired - 510 = Unemployed - 520 = Student - 530 = Subsidiary incomer - Blank = Unknown
employmentStartDatestring8Start date at current employer. Format: yyyymmdd.
employerMccstring4Reserved. Merchant Category Code (MCC) or Standard Industrial Classification (SIC) of employer.
occupationCodestring4Occupation or Job Code of the customer using ISCO-08 (International Standard Classification of Occupations).
incomestring16Current monthly salary, expressed in full units of the currency specified in currencyCode.
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
homePhonestring24Home telephone number of the customer.
secondaryPhonestring24Secondary telephone number of the customer.
workPhonestring24Work telephone number of the customer.
mobilePhonestring24Mobile phone number of the customer.
preferredPhonestring1Preferred phone number when contacting customer: - H = Home - S = Secondary - W = Work - M = Mobile
emailAddressstring40The email address provided by the customer.
educationalStatusstring1Highest educational level attained by the customer: - L = Less than high school - H = High school - GED - C = College 2 years - AA - B = Bachelor's degree - M = Master's degree - P = Professional degree (law, business, medical) - D = Doctorate - O = Other - U = Unknown
birthDatestring8Customer's date of birth. Format: yyyymmdd.
birthCountrystring3ISO 3166-1 three-digit numeric country code for country of birth.
citizenshipCountrystring3ISO 3166-1 three-digit numeric country code for country of citizenship.
nationalIdstring16Primary Identification Number provided by the customer. In the United States, this is the Social Security number.
nationalIdCountrystring3ISO 3166-1 three-digit numeric country code for national identification number.
passportNumberstring16Passport number.
passportCountrystring3ISO 3166-1 three-digit numeric country code for the country of the customer's passport.
passportExpirationDatestring8Date on which passport expires.
driversLicenseNumberstring16Driver's license number of the customer.
driversLicenseCountrystring3ISO 3166-1 three-digit numeric country code for driver's license number.
taxIdstring16Tax identification number.
taxIdCountrystring3ISO 3166-1 three-digit numeric country code for tax identification number.
genderstring1Gender of the customer: - M = Male - F = Female - U = Unknown
maritalStatusstring1Marital status of the customer: - S = Single - M = Married - D = Divorced - W = Widowed - E = Separated - O = Other - U = Unknown
numberOfDependentsstring2Number of dependents.
creditScorestring4Credit score of the customer.
creditScoreDatestring8Date the credit score for the customer was captured. Format: yyyymmdd.
creditScoreSourcestring20Source of the credit score.
creditScoreRequestReasonstring1Reason for requesting the credit score: - N = Application for a new credit/loan account. - C = Customer request for a change to an existing account (for example, credit limit increase, overdraft protection). - S = New product or service offering. - R = Routine review. - V = Review due to an adverse condition (for example, delinquency, overdraft) - O = Other - U = Unknown
creditRatingstring4Grouping of customers by credit worthiness.
pefpstring1Indicates whether or not the customer is on a list of Politically Exposed Foreign Persons: - Y = Yes - N = No - Blank = Unknown
ofacstring1Indicates whether the customer is on the list of entities and individuals that are blocked under the Office of Foreign Assets Control sanctions programs: - Y = Yes - N = No - Blank = Unknown
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_CIS": {
            "header": {
                "msg_id": "236001",
                "msg_type": "TRANSACTION",
                "msg_function": "REQ_FALCON_CIS",
                "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": "CIS20",
                "dataSpecificationVersion": "2.0",
                "clientIdFromHeader": "D360",
                "recordCreationDate": "20230912",
                "recordCreationTime": "160912",
                "recordCreationMilliseconds": "234",
                "gmtOffset": "+03.00",
                "customerIdFromHeader": "12345000000001",
                "customerAcctNumber": "0009991110000000001",
                "externalTransactionId": "D360CIS000000000001",
                "customerType": "S",
                "vipType": "S",
                "relationshipStartDate": "20230913",
                "numberOfAccounts": "2",
                "givenName": "ABDUL QPUADIR RAHMAN HUSAINXX",
                "middleName": "ABDUL QPUADIR RAHMAN HUSAINXX",
                "surname": "ABDUL QPUADIR RAHMAN HUSAINXX",
                "title": "MR",
                "suffix": "MR",
                "preferredGreeting": "Mr. John Smith",
                "preferredLanguage": "EN",
                "mothersMaidenName": "Doe",
                "householdName": "Smith Family",
                "streetLine1": "123 Main St",
                "streetLine2": "Apt 4B",
                "streetLine3": "Building 2",
                "streetLine4": "Floor 5",
                "city": "RIYADH",
                "stateProvince": "CA",
                "postalCode": "12345",
                "countryCode": "US",
                "residenceStatus": "O",
                "dateAtAddress": "20230101",
                "secondaryAddrType": "M",
                "secondaryAddrStreetLine1": "456 Secondary St",
                "secondaryAddrStreetLine2": "Apt 12C",
                "secondaryAddrStreetLine3": "Building B",
                "secondaryAddrStreetLine4": "Floor 2",
                "secondaryAddrCity": "Los Angeles",
                "secondaryAddrStateProvince": "CA",
                "secondaryAddrPostalCode": "90001",
                "secondaryAddrCountryCode": "US",
                "employer": "Acme Corp",
                "workAddrStreetLine1": "789 Work Rd",
                "workAddrStreetLine2": "Suite 101",
                "workAddrStreetLine3": "Building C",
                "workAddrStreetLine4": "Floor 3",
                "workAddrCity": "San Francisco",
                "workAddrStateProvince": "CA",
                "workAddrPostalCode": "94105",
                "workAddrCountryCode": "US",
                "employmentStatus": "400",
                "employmentStartDate": "20230101",
                "employerMcc": "1234",
                "occupationCode": "1234",
                "income": "5000",
                "currencyCode": "SAR",
                "currencyConversionRate": "1",
                "homePhone": "123-456-7890",
                "secondaryPhone": "987-654-3210",
                "workPhone": "555-123-4567",
                "mobilePhone": "555-987-6543",
                "preferredPhone": "M",
                "emailAddress": "customer@example.com",
                "educationalStatus": "B",
                "birthDate": "19850101",
                "birthCountry": "840",
                "citizenshipCountry": "840",
                "nationalId": "123-45-6789",
                "nationalIdCountry": "840",
                "passportNumber": "P123456789",
                "passportCountry": "840",
                "passportExpirationDate": "20250101",
                "driversLicenseNumber": "D12345678",
                "driversLicenseCountry": "840",
                "taxId": "123-45-6789",
                "taxIdCountry": "840",
                "gender": "M",
                "maritalStatus": "M",
                "numberOfDependents": "2",
                "creditScore": "700",
                "creditScoreDate": "20230101",
                "creditScoreSource": "Equifax",
                "creditScoreRequestReason": "N",
                "creditRating": "A",
                "pefp": "Y",
                "ofac": "Y",
                "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_CISheadermsg_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_CIS”
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_CIS": {
            "header": {
                "msg_id": "236001",
                "msg_type": "TRANSACTION",
                "msg_function": "REP_FALCON_CIS",
                "src_application": "TIBCO",
                "target_application": "FALCON",
                "timestamp": "2020-07-20T06:49:02.366Z",
                "bank_id": "NIC"
            },
            "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