• Register

Customer Information Summary

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 customer.

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_CIS" 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
        Optional
workflow String 16 Contains the name of the workflow to be executed by Falcon Fraud Manager. Optional
recordType String 8 CIS20 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 Customer Identifier.  Financial institution's unique identifier for the customer. Optional
customerAcctNumber String 40 Filled with blanks. 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
customerType String 1 Reserved. Optional
Type of entity providing application: Optional
I = Individual Optional
M = Individual minor Optional
B = Small business Optional
C = Corporation Optional
G = Government Optional
O = Other Optional
vipType String 1 Very Important Person (VIP) indicator: Optional
S = Standard Optional
V = VIP Optional
relationshipStartDate Date 8 Format: yyyymmdd Optional
Date of first business relationship with customer. Optional
numberOfAccounts Numeric 5 Total number of open accounts linked to this customer, regardless of account type. Optional
givenName String 30 Given name of the customer. In the United States, this is first name. Optional
middleName String 30 Middle name of the customer. Optional
surname String 60 Surname of the customer. In the United States, this is last name. Optional
title String 10 Name prefix (for example, Mr., Mrs., Dr.) Optional
suffix String 10 Name suffix of the customer (for example, Sr., Jr., III.). Optional
preferredGreeting String 60 Preferred way to greet the customer in communications (for example, Mr. John Smith, Ms. Davis). Optional
preferredLanguage String 3 Preferred customer language.  Optional
mothersMaidenName String 60 Maiden name of customer's mother. Optional
householdName String 60 Reserved. Optional
Family name of owner of the residence where customer lives. Optional
streetLine1 String 40 Primary address: Street address line 1. Optional
streetLine2 String 40 Primary address: Street address line 2. Optional
streetLine3 String 40 Primary address: Street address line 3. Optional
streetLine4 String 40 Primary address: Street address line 4. Optional
city String 40 Primary address: city. Optional
stateProvince String 3 Primary address: province or state.  Optional
postalCode String 10 Primary address: postal code. Optional
countryCode String 3 Primary address: country.  Optional
residenceStatus String 1 Residence status: Optional
O = Owns residence Optional
R = Rents Optional
F = Family owned Optional
E = Employer provided Optional
S = University/college/school Optional
T = Other Optional
U = Unknown Optional
dateAtAddress Date 8 Format: yyyymmdd Optional
Start date at current address. Optional
secondaryAddrType String 1 Secondary address type: Optional
M = Mailing address Optional
P = Post office box Optional
O = Other classification Optional
U = Unknown Optional
secondaryAddrStreetLine1 String 40 Secondary address: Street address line 1. Optional
secondaryAddrStreetLine2 String 40 Secondary address: Street address line 2. Optional
secondaryAddrStreetLine3 String 40 Secondary address: Street address line 3. Optional
secondaryAddrStreetLine4 String 40 Secondary address: Street address line 4. Optional
secondaryAddrCity String 40 Secondary address: city. Optional
secondaryAddrStateProvince String 3 Secondary address: province or state. Optional
secondaryAddrPostalCode String 10 Secondary address: postal code. Optional
secondaryAddrCountryCode String 3 Secondary address: country.  Optional
employer String 60 Name of customer's employer. Optional
workAddrStreetLine1 String 40 Work address: Street address line 1. Optional
workAddrStreetLine2 String 40 Work address: Street address line 2. Optional
workAddrStreetLine3 String 40 Work address: Street address line 3. Optional
workAddrStreetLine4 String 40 Work address: Street address line 4. Optional
workAddrCity String 40 Work address: city. Optional
workAddrStateProvince String 3 Work address: province or state.  Optional
workAddrPostalCode String 10 Work address: postal code. Optional
workAddrCountryCode String 3 Work address: country.  Optional
employmentStatus String 3 Employment status: Optional
400 = Private sector Optional
410 = Government sector Optional
420 = Business owner Optional
500 = Retired Optional
510 = Unemployed Optional
520 = Student Optional
530 = Subsidiary incomer Optional
Blank = Unknown Optional
employmentStartDate Date 8 Format: yyyymmdd Optional
Start date at current employer. Optional
employerMcc String 4 Reserved. Optional
Merchant Category Code (MCC) or Standard Industrial Classification (SIC) of employer.   Optional
occupationCode String 4 Occupation or Job Code of the customer using ISCO-08 (International Standard Classification of Occupations). Optional
income Numeric 16 Current monthly salary, expressed in full units of the currency specified in currencyCode.  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
homePhone String 24 Home telephone number of the customer. Optional
secondaryPhone String 24 Secondary telephone number of the customer. Optional
workPhone String 24 Work telephone number of the customer. Optional
mobilePhone String 24 Mobile phone number of the customer. Optional
preferredPhone String 1 Preferred phone number when contacting customer: Optional
H = Home Optional
S = Secondary Optional
W = Work Optional
M = Mobile Optional
emailAddress String 40 The email address provided by the customer. Optional
educationalStatus String 1 Highest educational level attained by the customer: Optional
L = Less than high school Optional
H = High school - GED Optional
C = College 2 years - AA Optional
B = Bachelor's degree Optional
M = Master's degree Optional
P = Professional degree (law, business, medical) Optional
D = Doctorate Optional
O = Other Optional
U = Unknown Optional
birthDate Date 8 Format: yyyymmdd Optional
Customer's date of birth. Optional
birthCountry String 3 ISO 3166-1 three-digit numeric country code for country of birth.  Optional
citizenshipCountry String 3 ISO 3166-1 three-digit numeric country code for country of citizenship.  Optional
nationalId String 16 Primary Identification Number provided by the customer. In the United States, this is the Social Security number. Optional
nationalIdCountry String 3 ISO 3166-1 three-digit numeric country code for national identification number.  Optional
passportNumber String 16 Passport number. Optional
passportCountry String 3 ISO 3166-1 three-digit numeric country code for the country of the customer's passport.  Optional
passportExpirationDate Date 8 Date on which passport expires. Optional
driversLicenseNumber String 16 Driver's license number of the customer. Optional
driversLicenseCountry String 3 ISO 3166-1 three-digit numeric country code for driver's license number.  Optional
taxId String 16 Tax identification number. Optional
taxIdCountry String 3 ISO 3166-1 three-digit numeric country code for tax identification number.  Optional
gender String 1 Gender of the customer: Optional
M = Male Optional
F = Female Optional
U = Unknown Optional
maritalStatus String 1 Marital status of the customer: Optional
S = Single Optional
M = Married Optional
D = Divorced Optional
W = Widowed Optional
E = Separated Optional
O = Other Optional
U = Unknown Optional
numberOfDependents Numeric 2 Number of dependents.  Optional
creditScore Numeric 4 Credit score of the customer.  Optional
creditScoreDate Date 8 Format: yyyymmdd Optional
Date the credit score for the customer was captured. Optional
creditScoreSource String 20 Source of the credit score. Optional
creditScoreRequestReason String 1 Reason for requesting the credit score: Optional
N = Application for a new credit/loan account. Optional
C = Customer request for a change to an existing account (for example, credit limit increase, overdraft protection). Optional
S = New product or service offering. Optional
R = Routine review. Optional
V = Review due to an adverse condition (for example, delinquency, overdraft) Optional
O = Other Optional
U = Unknown Optional
creditRating String 4 Grouping of customers by credit worthiness. Optional
pefp String 1 Indicates whether or not the customer is on a list of Politically Exposed Foreign Persons: Optional
Y = Yes Optional
N = No Optional
Blank = Unknown Optional
ofac String 1 Indicates whether the customer is on the list of entities and individuals that are blocked under the Office of Foreign Assets Control sanctions programs: Optional
Y = Yes Optional
N = No Optional
Blank = Unknown Optional
behaviorScore1 Numeric 4 First behavior score.  Optional
behaviorScore2 Numeric 4 Second behavior score.  Optional
segmentId1 String 6 Segmentation ID of the customer. Reserved for FICO modeling.  Optional
segmentId2 String 6 Segmentation ID of the customer. Reserved for FICO modeling.  Optional
segmentId3 String 6 Segmentation ID of the customer. Reserved for FICO modeling.  Optional
segmentId4 String 6 Segmentation ID of the customer. 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_CIS"
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_cis": {
            "header": {
                "msg_id": "1694593680",
                "msg_type": "TRANSACTION",
                "msg_function": "REQ_FALCON_CIS",
                "src_application": "TIBCO",
                "target_application": "FALCON",
                "timestamp": "2020-07-19T12:59:21.609+04:00",
                "tracking_id": 1694593680,
                "bank_id": "default",
                "instance_id": 1694593680
            },
            "body": {
                "tranCode": "103",
                "source": "TIBCO",
                "dest": "FLACON",
                "extendedHeader": "EXTENDEDHEADER130001",
                "workflow": "modelSTUB",
                "recordType": "CIS20",
                "dataSpecificationVersion": "2.0",
                "clientIdFromHeader": "D360",
                "recordCreationDate": "20230912",
                "recordCreationTime": "160912",
                "recordCreationMilliseconds": "234",
                "gmtOffset": "+03.00",
                "customerIdFromHeader": "12345000000002",
                "customerAcctNumber": "000999111000000002",
                "externalTransactionId": "D360CIS000000001",
                "customerType": "I",
                "vipType": "S",
                "relationshipStartDate": "20230913",
                "numberOfAccounts": 2,
                "givenName": "ABDUL QPUADIR RAHMAN HUSAINXX",
                "middleName": "ABDUL QPUADIR RAHMAN HUSAINXX",
                "surname": "ABDUL QPUADIR RAHMAN HUSAINXX",
                "title": "MR.",
                "suffix": "SIR",
                "preferredGreeting": "HI HELLO HOW ARE YOU",
                "preferredLanguage": "ENG",
                "mothersMaidenName": "ABDUL QPUADIR RAHMAN HUSAINXX",
                "householdName": "DOWN TOWN, NOTH MAIN ROAD, KINGSBUSSRY FLORIDA, 1243",
                "streetLine1": "STATEMENT ADDRESS LINE 1",
                "streetLine2": "STATEMENT ADDRESS LINE 2",
                "streetLine3": "STATEMENT ADDRESS LINE 3",
                "streetLine4": "STATEMENT ADDRESS LINE 4",
                "city": "RIYADH",
                "stateProvince": "RIY",
                "postalCode": "HSP0015G",
                "countryCode": "682",
                "residenceStatus": "O",
                "dateAtAddress": "20011231",
                "secondaryAddrType": "P",
                "secondaryAddrStreetLine1": "SECOND-ADDRESS:STREET * LINE 1",
                "secondaryAddrStreetLine2": "SECOND!ADDRESS@STREET # LINE 2",
                "secondaryAddrStreetLine3": "SECOND$ADDRESS%STREET ^ LINE 3",
                "secondaryAddrStreetLine4": "SECOND(ADDRESS)STREET _ LINE 4",
                "secondaryAddrCity": "JEDDAH",
                "secondaryAddrStateProvince": "JED",
                "secondaryAddrPostalCode": "STR 91 JED",
                "secondaryAddrCountryCode": "682",
                "employer": "D360 BANK LIMITED SA",
                "workAddrStreetLine1": "WORK-ADDRESS:STREET * LINE 1",
                "workAddrStreetLine2": "WORK!ADDRESS@STREET # LINE 2",
                "workAddrStreetLine3": "WORK$ADDRESS%STREET ^ LINE 3",
                "workAddrStreetLine4": "WORK(ADDRESS)STREET _ LINE 4",
                "workAddrCity": "DAMMAM",
                "workAddrStateProvince": "DAM",
                "workAddrPostalCode": "DAM 102MAM",
                "workAddrCountryCode": "682",
                "employmentStatus": "400",
                "employmentStartDate": "20200320",
                "employerMcc": "5654",
                "occupationCode": "2310",
                "income": 1122334455,
                "currencyCode": "SAR",
                "currencyConversionRate": 1.25,
                "homePhone": "+966500825001",
                "secondaryPhone": "+966500825002",
                "workPhone": "+966500825003",
                "mobilePhone": "+966500825004",
                "preferredPhone": "M",
                "emailAddress": "abdullaali@dmail.com",
                "educationalStatus": "C",
                "birthDate": "19860321",
                "birthCountry": "682",
                "citizenshipCountry": "682",
                "nationalId": "SA00987123",
                "nationalIdCountry": "682",
                "passportNumber": "SPAS G 10023",
                "passportCountry": "682",
                "passportExpirationDate": "20270124",
                "driversLicenseNumber": "SA DRV 12309",
                "driversLicenseCountry": "682",
                "taxId": "TXN_0001",
                "taxIdCountry": "682",
                "gender": "M",
                "maritalStatus": "E",
                "numberOfDependents": 4,
                "creditScore": 401,
                "creditScoreDate": "20230901",
                "creditScoreSource": "OPRIMA",
                "creditScoreRequestReason": "C",
                "creditRating": "C109",
                "pefp": "Y",
                "ofac": "N",
                "behaviorScore1": 5010,
                "behaviorScore2": 6020,
                "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": "USRDT1",
                "userData02": "USRDT2",
                "userData03": "USRDT3",
                "userData04": "USERDAT4",
                "userData05": "USERDAT5",
                "userData06": "USERDAT6",
                "userData07": "USERDATA07",
                "userData08": "USERDATA08",
                "userData09": "USER DATA 09000",
                "userData10": "USER DATA 01000",
                "userData11": "USER DATA 110000000",
                "userData12": "USER DATA 120000000",
                "userData13": "USER DATA 13000000000000000000000000000X",
                "userData14": "USER DATA 14000000000000000000000000000X",
                "userData15": "USER DATA 1500000000000000000000000000000000000000000000000X",
                "RESERVED_01": "RESERVED_01"
            }
        }
    }
}

Response Json

{
    "response_cis": {
        "header": {
            "msg_id": "1694773739",
            "msg_type": "TRANSACTION",
            "msg_function": "REP_FALCON_CIS",
            "src_application": "TIBCO",
            "target_application": "FALCON",
            "timestamp": "2023-09-15T13:28:59.156+03:00",
            "tracking_id": "1694773739",
            "bank_id": "default"
        },
        "exception_details": {
            "application_name": "",
            "date_time": "2023-09-15T13:28:59.135+03:00",
            "status": "S",
            "error_code": "000",
            "error_description": "Success"
        },
        "body": {
            "tran_code": "103",
            "source": "PMAX",
            "destination": "TIBCO",
            "extended_header": "EXTENDEDHEADER130005",
            "responseRecordVersion": "4",
            "scoreCount": "00",
            "decisionCount": "0"
        }
    }
}

Docs Navigation