商家银行业务资本市场企业 Developer

见解与透视关于联系我们

打电话给我们

+1 877.776.3706

向我们发送电子邮件

getinfo@fisglobal.com

总部

Jacksonville, Florida United States

需要支持

WorldPay 现在是 FIS。您的体验是我们的头等要务。我们随时为您提供支持。

获得支持

Ethos™ Clarity API 1.0.0) (OAS3)

KLI

Retrieve detailed information about:

The insights (Key Lifestyle Indicators KLIs) that are assigned to a single UCIC of the Financial Institution.
The list of customers (UCICs) that have a single KLI assignment in common, including the other KLIs assigned to each customer.
Descriptive details for all KLIs assigned to the customers of the Financial Institution.
Descriptive details for a specific KLI within the Clarity KLI taxonomy, including the count of customers assigned and the list of parent KLIs.
Retrieve the list of KLI that are categorized within a group (defined as children) of the Clarity KLI taxonomy.

Merchant

Retrieve transaction details such as: scrubbed merchant name, merchant classification, links to download merchant logo (if available) and MCC logo (if available).

A list of sample transactions can be seen below:

Sample transaction strings:

MERCHANT PURCHASE TERMINAL COSTCO WHSE WINTER PA FL : PM SEQ #

LOWES HOME CENTE

KONA ACE HARDWARE KAILUA-KONA HI USA96740

POS PURCHASE TERMINAL TREK COMPANY STORE MADISON WI

MERCHANT PURCHASE TERMINAL BRUEGGER S MINNETONK MN

HEAV NLY DONUTS BRENTWOOD NH

LEMONGRASS RESTAURANT KEAAU HI US

OHIO STATE UNIV

CTC CONSTANTCONTACT.CO CTC CONSTANTCONTACT.CO 855-2295506 MA 9594

TRAVELERSHELPER.BI Z LONDON

CARNIVAL FRDOM SAIL SG CARNIVAL FRDOM SAI MIAMI FL US

BB&T MORTGAGE ONLINE PMT

NAVI ED SERV WEB STUDNTLOAN MTIBF

UBO XYF JOHN HANCOCK FREED

SP KABBAGE ONESI ES HTTPSFUTU GA

UCIC

Retrieve a list of insights and goals achieved by a single customer or for a group of customers using a set of query string parameters.

V2

Endpoints beginning with /v2 use camel casing instead of the snake casing that /v1 uses. Camel casing will be the strategy used going forward. /v2 endpoints can be accessed with auth tokens acquired from /v1.

Integrations

When integrating with Clarity APIs you should always allow for unknown fields. FIS reserves the right to add additional fields to its APIs. FIS will always attempt to not introduce breaking changes into an endpoint. This is often accomplished by the addition of fields. If a breaking change is required clients will be given advanced notice to make the required changes.

Access to API endpoints may be rate limited and have monthly account level quotas, your account representative will have details if this applies to you.

Authentication

BasicAuthentication

Use the provided User ID and password to authenticate.

Security Scheme Type	HTTP
HTTP Authorization Scheme	basic

BearerAuthentication

Obtain a token using the /auth/v1/token endpoint

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

/auth

Change your password used to access the Clarity Data Insights APIs.

Call this API passing a JSON request to change your password.
Password Policy -

8 Characters
Require Numbers
Require special characters
Require Uppercase Characters
Require Lowercase Characters

Request Body schema: application/json

The JSON Body of the POST to change your current password

username required	string The username provided to you via the Clarity Data Services Welcome email.
password required	string Your current password. For new users this would be the password provided to you via the Clarity Data Services Welcome email.
new_password required	string A new strong password that meets Clarity Data Services API password policy card processor criteria.

Responses

200

400

A JSON object that contains Bad Request messages

404

Not Found

500

Server Error

post/auth/v1/changePassword

https://[FIS-api-host]/auth/v1/changePassword

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"username": "somebody@somebank.com",
"password": "342_9B1B",
"new_password": "P@$$w0rd!"
}

Refresh authentication token

Call this API to get a new token when previous token expires

Authorizations:

BasicAuthentication

Responses

200

400

Bad Request. Check your credentials.

404

Not Found

500

Server Error

post/auth/v1/token

https://[FIS-api-host]/auth/v1/token

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"token": "eyJraWQiOiJKNHl6dmdGZ3VWbityS2s3Wmt2NnBQTGtMK2hwY20zS09lSlJ5MHNaZnJBPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI3ZjQzZTM3YS0wMzQ3LTRmMTktYmRlMC1hNTgwNGE3YjNkYjQiLCJjdXN0b206cGFydG5lcl9saXN0IjoiODc1NjI2ODgiLCJpc3MiOiJodHRwczpcL1wvY29nbml0by1pZHAudXMtZWFzdC0xLmFtYXpvbmF3cy5jb21cL3VzLWVhc3QtMV9BS2tNT1VBN0YiLCJjb2duaXRvOnVzZXJuYW1lIjoibGFuY2UuY3V0aGJlcnRAc2VnbWludC5jb20iLCJjdXN0b206cm9vdF9wYXJ0bmVyIjoiODc1NjI2ODgiLCJhdWQiOiIzZjUzM2I1czI4OHI0YmNsamNndWN1NHY0ciIsImV2ZW50X2lkIjoiYmJkZTYzNjEtMjBkNC0xMWU5LWJiYTktNGI2MGIzMjg1NDE4IiwidG9rZW5fdXNlIjoiaWQiLCJhdXRoX3RpbWUiOjE1NDg0NDMzNjcsImN1c3RvbTpwZXJtaXNzaW9uX2xpc3QiOiIsTUVSQ0hBTlQiLCJleHAiOjE1NDg0NDY5NjcsImlhdCI6MTU0ODQ0MzM2NywiZW1haWwiOiJsYW5jZS5jdXRoYmVydEBzZWdtaW50LmNvbSJ9.L9ORpHtxwJ3nBtgMZrQowDotlI0zQy9SZN2uAJj8g_JfJgQ-liK3rTn21IcJdWoS7iPKu-Wq9PT6Zl9jnn71Z7CZ97ipkd9JgLb2W0Brptgm69TRGLr0xWDAsXgqvW8VChT8KHSr3fOCeiz1zDWI2ZBKNj_PDiHRsJn7Xmrkc-joS3TiXtJRyW6TqtoWlf_--GKivzAoJiMkQxlNKYGm5I_NOUYL7x2awJce74jE4b6uqrRG5On1_1X9hKTD2G5L6CYZpz95Xzzeegl-ccuV3lRkzrau-lrc5eHABaFUupm7vMcp3JIbBTCvgJgw8WcuP1JA57TIAW67rfqaMmkWdg",
"expires_in": 3600
}

/kli

List of KLIs assigned to a customer

Call this API passing an FIS supplied partner_id and UCIC along with query parameters to retrieve KLI details about a customer (UCIC).

Use the kli_code as an input to the “Details for a single KLI” endpoint to obtain additional information about the specific KLI.

kli_class - kli_class returns an indicator if the KLI is public or private to the Financial Institution. The majority of KLI are public KLI indicating that they are available to be assigned to customers of all Financial Institutions. Private KLI are limited to FI Products describing the unique products and services available to FI customers.

kli_is_competitive - This query parameter can be used to filter the list of KLI results to only those within the Competitive FI Products & Activity branch of the taxonomy.

kli_is_leaf - kli_is_leaf returns the lowest level of the Clarity KLI taxonomy.

For example -

Branch	Leaf KLI
Consumer Spend	Merchants of transactions processed. Parents of leaf KLI provide categorization of the merchants.
Competitive Banks	Financial Institutions of transactions processed. Parents of leaf KLI provide type of FI, Credit Unions, Domestic Banks, Foreign Banks, etc.
Competitive FI Products	Financial Institutions and products for which transactions processed (e.g. Wells Fargo Mortgage). Parents of leaf KLI provide type of product for which payment was made.
Competitive Payment Activity	Details of payment activity including product and payment range. Parents of leaf KLI provide category of payment activity and product type.
Customer Behavior Indicators	Specific behavior identified for the customer (e.g. HELOC Utilization: 0%). Parents of leaf KLI provide categories of behavior.

Please note: Do not choose to select kli_class of PRIVATE with kli_is_competitive of TRUE. This results in a null return because the Competitive branch of the KLI taxonomy is public.

Authorizations:

BearerAuthentication

path Parameters

partner_id required	integer Partner ID provided to the Financial Institution by FIS.
ucic required	string UCIC of the Financial Institution customer for which you wish to receive the set insights (KLIs) assigned.

query Parameters

kli_class	string Enum: "PUBLIC" "PRIVATE" Indicator describing the privacy of the KLI, Public or Private to the Financial Institution.
kli_is_competitive	boolean Enum: true false Flag (Y/N) indicating if the KLI describes a customer insight related to activity with competitive Financial Institutions.
kli_is_leaf	boolean Flag (Y/N) indicating if the KLI is at the lowest level of the Clarity KLI taxonomy (no children KLIs exist).
kli_is_active	boolean Flag (Y/N) indicating if the KLIs are active for the customers

Responses

200

401

Unauthorized

404

Not found

500

Server error

get/kli/v1/partners/{partner_id}/ucics/{ucic}/kli_assignments

https://clarity-stage.fisglobal.com/kli/v1/partners/{partner_id}/ucics/{ucic}/kli_assignments

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"kli_code": 8850775,
"kli_is_active": true,
"kli_class": "PUBLIC",
"kli_categorization": "OTHER COMPETITIVE BANKING TRANSACTIONS",
"kli_description": "MISC. TRANSACTION FEE",
"kli_is_competitive": true,
"kli_is_leaf": true,
"primary_attribute": "string",
"primary_owner": true,
"uaic": "string",
"uaic_close_date": "string",
"uaic_open_date": "string"
}

List of KLIs within a group(section) of the KLI taxonomy for all customers

Call this API passing a FIS supplied partner_id, kli_code and query parameters (optional) to retrieve details about the children KLIs included in the group (section) that are assigned to customers.

Use the KLI listed in the kli_assigned as an input to the “Details for a single KLI” endpoint to obtain additional information about the specific KLI.

KLI	KLI Code	Public / Private
Competitive Banks	8847985	Public
Competitive FI Products	39668008	Public
Competitive Mortgages	8784829	Public
Competitive Credit Cards	8784829	Public
Competitive Investments	10595307	Public
Competitive Payment Activity	33805546	Public
Predictive Indicators	12561887	Public
FI Products	12259279	Leaf are Private
Consumer Spend	8616194	Public
Life Events	8080149	Public
Food and Dining	8080068	Public
Activities & Interests	8080101	Public
Customer Behavior Indicators	10595179	Public

Branch	Leaf KLI
Consumer Spend	Merchants of transactions processed. Parents of leaf KLI provide categorization of the merchants.
Competitive Banks	Financial Institutions of transactions processed. Parents of leaf KLI provide type of FI, Credit Unions, Domestic Banks, Foreign Banks, etc.
Competitive FI Products	Financial Institutions and products for which transactions processed (e.g. Wells Fargo Mortgage). Parents of leaf KLI provide type of product for which payment was made.
Competitive Payment Activity	Details of payment activity including product and payment range. Parents of leaf KLI provide category of payment activity and product type.
Customer Behavior Indicators	Specific behavior identified for the customer (e.g. HELOC Utilization: 0%). Parents of leaf KLI provide categories of behavior.

Please note: Do not choose to select kli_class of PRIVATE with kli_is_competitive of TRUE. This results in a null return because the Competitive branch of the KLI taxonomy is public.

Authorizations:

BearerAuthentication

path Parameters

partner_id required	integer Partner ID provided to the Financial Institution by FIS
kli_code required	integer KLI code being searched.

query Parameters

kli_class	string Enum: "PUBLIC" "PRIVATE" Indicator describing the privacy of the KLI, Public or Private to the Financial Insitution.
kli_is_competitive	boolean Enum: true false Flag (Y/N) indicating if the KLI describes a customer insight related to activity competitive Financial Institution.
kli_is_leaf	boolean Enum: true false Flag (Y/N) indicating if the KLI is at the lowest level of the Clarity KLI taxonomy (no children KLIs exist).
limit	integer Number of rows to be returned per page (default 1000).
offset	integer Starting row number for this page of data.

Responses

200

401

Unauthorized

404

Not found

500

Server error

get/kli/v1/partners/{partner_id}/kli_assignments/{kli_code}/children

https://clarity-stage.fisglobal.com/kli/v1/partners/{partner_id}/kli_assignments/{kli_code}/children

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"metadata": 
{"limit": 5,
"offset": 0,
"current": "https://clarity-stage.fisglobal.com/kli/v1/partners/12345678/kli_assignments/39668008/children?kli_class=PUBLIC&kli_is_leaf=TRUE&ucic=000c6b38-7411-43d4-b794-f98ae1a0b14a&limit=100",
"next": "https://clarity-stage.fisglobal.com/kli/v1/partners/12345678/kli_assignments/39668008/children?kli_class=PUBLIC&kli_is_leaf=TRUE&ucic=000c6b38-7411-43d4-b794-f98ae1a0b14a&limit=100&limit=40&offset=40",
"page_total": 5
},
"content": 
[
{"kli_code": 8850775,
"kli_is_active": true,
"kli_class": "PUBLIC",
"kli_categorization": "OTHER COMPETITIVE BANKING TRANSACTIONS",
"kli_description": "MISC. TRANSACTION FEE",
"kli_is_competitive": true,
"kli_is_leaf": true,
"primary_attribute": "string",
"primary_owner": true,
"ucic": "e2c96790-fd69-11e8-9ff7-bf083b0e566c",
"uaic": "string",
"uaic_close_date": "string",
"uaic_open_date": "string"
}
]
}

List of KLIs within a group(section) of the KLI taxonomy

Call this API passing a FIS supplied partner_id, kli_code and query parameters (optional) to retrieve details about the children KLIs included in the group (section) that are assigned to customers.

Use the KLI listed in the kli_assigned as an input to the “Details for a single KLI” endpoint to obtain additional information about the specific KLI.

KLI	KLI Code	Public / Private
Competitive Banks	8847985	Public
Competitive FI Products	39668008	Public
Competitive Mortgages	8784829	Public
Competitive Credit Cards	8784829	Public
Competitive Investments	10595307	Public
Competitive Payment Activity	33805546	Public
Predictive Indicators	12561887	Public
FI Products	12259279	Leaf are Private
Consumer Spend	8616194	Public
Life Events	8080149	Public
Food and Dining	8080068	Public
Activities & Interests	8080101	Public
Customer Behavior Indicators	10595179	Public

Branch	Leaf KLI
Consumer Spend	Merchants of transactions processed. Parents of leaf KLI provide categorization of the merchants.
Competitive Banks	Financial Institutions of transactions processed. Parents of leaf KLI provide type of FI, Credit Unions, Domestic Banks, Foreign Banks, etc.
Competitive FI Products	Financial Institutions and products for which transactions processed (e.g. Wells Fargo Mortgage). Parents of leaf KLI provide type of product for which payment was made.
Competitive Payment Activity	Details of payment activity including product and payment range. Parents of leaf KLI provide category of payment activity and product type.
Customer Behavior Indicators	Specific behavior identified for the customer (e.g. HELOC Utilization: 0%). Parents of leaf KLI provide categories of behavior.

Please note: Do not choose to select kli_class of PRIVATE with kli_is_competitive of TRUE. This results in a null return because the Competitive branch of the KLI taxonomy is public.

Authorizations:

BearerAuthentication

path Parameters

partner_id required	integer Partner ID provided to the Financial Institution by FIS
ucic required	string UCIC of the Financial Institution customer for which you wish to receive the set insights (KLIs) assigned.
kli_code required	integer KLI code being searched.

query Parameters

kli_class	string Enum: "PUBLIC" "PRIVATE" Indicator describing the privacy of the KLI, Public or Private to the Financial Insitution.
kli_is_competitive	boolean Enum: true false Flag (Y/N) indicating if the KLI describes a customer insight related to activity competitive Financial Institution.
kli_is_leaf	boolean Enum: true false Flag (Y/N) indicating if the KLI is at the lowest level of the Clarity KLI taxonomy (no children KLIs exist).

Responses

200

401

Unauthorized

404

Not found

500

Server error

get/kli/v1/partners/{partner_id}/ucics/{ucic}/kli_assignments/{kli_code}/children

https://clarity-stage.fisglobal.com/kli/v1/partners/{partner_id}/ucics/{ucic}/kli_assignments/{kli_code}/children

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"kli_code": 8850775,
"kli_is_active": true,
"kli_class": "PUBLIC",
"kli_categorization": "OTHER COMPETITIVE BANKING TRANSACTIONS",
"kli_description": "MISC. TRANSACTION FEE",
"kli_is_competitive": true,
"kli_is_leaf": true,
"primary_attribute": "string",
"primary_owner": true,
"uaic": "string",
"uaic_close_date": "string",
"uaic_open_date": "string"
}

List of customers assigned a given KLI

Call this API passing a FIS supplied partner_id and KLI code along with query parameters to get back details about the customers that have the KLI assignment in common, including the other KLIs assigned to each customer.

Use the kli_code as an input to the “Details for a single KLI” endpoint to obtain additional information about the specific KLI.
Use the ucic as an input to the “Goals achieved for an individual customer” endpoint to gather more details about all goals achieved by the customer.

Authorizations:

BearerAuthentication

path Parameters

partner_id required	integer Partner ID provided to the Financial Institution by FIS.
kli_code required	integer KLI code being searched.

query Parameters

ucic_type	string Enum: "I" "O" Indicator describing the type of customer, 'I' individual or 'O' business / organization.
ucic_is_active	string Enum: true false Flag indicating if the customer is currently an active customer of the Financial Institution.
limit	integer Number of rows to be returned per page (default 1000).
offset	integer Row number to start returning data.

Responses

200

401

Unauthorized

404

Not found

500

Server error

get/kli/v1/partners/{partner_id}/kli_assignments/{kli_code}/ucic_details

https://clarity-stage.fisglobal.com/kli/v1/partners/{partner_id}/kli_assignments/{kli_code}/ucic_details

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"metadata": 
{"limit": 5,
"offset": 0,
"current": "https://clarity-stage.fisglobal.com/kli/v1/partners/12345678/kli_assignments/8784812/ucic_details?ucic_type=O&limit=5",
"next": "https://clarity-stage.fisglobal.com/kli/v1/partners/12345678/kli_assignments/8784812/ucic_details?ucic_type=O&limit=5&offset=5",
"page_total": 5
},
"content": 
[
{"ucic": "e2c96790-fd69-11e8-9ff7-bf083b0e566c",
"ucic_type": "I",
"ucic_is_active": true,
"ucic_process_date": "Thu, 01 Jan 2015 00:00:00 GMT",
"ucic_control_id": 0.466580814216286,
"kli_assigned": 
[33355203,
83202517,
83202560,
12070221,
10595230,
13638284,
34426081
]
}
]
}

Details for all KLIs assigned to FI customers

Call this API passing a FIS supplied partner_id and query parameters (optional) to retrieve details about the KLIs that are assigned to customers of the Financial Institution.

kli_class - kli_class returns an indicator if the KLI is public or private to the Financial Institution. The majority of KLI are public KLI indicating that they are available to be assigned to customers of all Financial Institutions. Private KLI are limited to FI Products describing the unique products and services available to FI customers.

kli_is_competitive - This query parameter can be used to filter the list of KLI results to only those within the Competitive FI Products & Activity branch of the taxonomy.

kli_is_leaf - kli_is_leaf returns the lowest level of the Clarity KLI taxonomy.

For example -

Branch	Leaf KLI
Consumer Spend	Merchants of transactions processed. Parents of leaf KLI provide categorization of the merchants.
Competitive Banks	Financial Institutions of transactions processed. Parents of leaf KLI provide type of FI, Credit Unions, Domestic Banks, Foreign Banks, etc.
Competitive FI Products	Financial Institutions and products for which transactions processed (e.g. Wells Fargo Mortgage). Parents of leaf KLI provide type of product for which payment was made.
Competitive Payment Activity	Details of payment activity including product and payment range. Parents of leaf KLI provide category of payment activity and product type.
Customer Behavior Indicators	Specific behavior identified for the customer (e.g. HELOC Utilization: 0%). Parents of leaf KLI provide categories of behavior.

Please note: Do not choose to select kli_class of PRIVATE with kli_is_competitive of TRUE. This results in a null return because the Competitive branch of the KLI taxonomy is public.

Authorizations:

BearerAuthentication

path Parameters

partner_id

required

integer

Partner ID provided to the Financial Institution by FIS.

query Parameters

kli_class	string Enum: "PUBLIC" "PRIVATE" Indicator describing the privacy of the KLI, Public or Private to the Financial Institution.
kli_is_competitive	boolean Enum: true false Flag (Y/N) indicating if the KLI describes a customer insight related to activity with competitive Financial Institutions.
kli_is_leaf	boolean Enum: true false Flag (Y/N) indicating if the KLI is at the lowest level of the Clarity KLI taxonomy (no children KLIs exist).
limit	integer Number of rows to be returned per page (default 1000).
offset	integer Row number to start returning data.

Responses

200

401

Unauthorized

404

Not found

500

Server error

get/kli/v1/partners/{partner_id}/kli_details

https://clarity-stage.fisglobal.com/kli/v1/partners/{partner_id}/kli_details

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"metadata": 
{"limit": 5,
"offset": 0,
"current": "https://clarity-stage.fisglobal.com/kli/v1/partners/12345678/kli_details?kli_is_leaf=TRUE&kli_class=PRIVATE&limit=40",
"next": "https://clarity-stage.fisglobal.com/kli/v1/partners/12345678/kli_details?kli_class=PRIVATE&kli_is_leaf=TRUE&limit=40&offset=40",
"page_total": 5
},
"content": 
[
{"kli_code": 8784812,
"kli_desc": "BANK OF AMERICA MORTGAGES",
"kli_class": "PUBLIC",
"kli_is_leaf": true,
"kli_is_competitive": true,
"kli_merchant_domain": "bankofamerica.com",
"kli_merchant_logo_url": "string",
"kli_mcc_code": "string",
"kli_mcc_logo_url": "string",
"kli_relation_codes": "8784781:8847985:8847986:8849168:8784812 | 8784781:39668008:8784808:8784812",
"kli_relation_descs": "COMPETITIVE FI PRODUCTS & ACTIVITY:COMPETITIVE BANKS:COMPETITIVE DOMESTIC BANKS:BANK OF AMERICA:BANK OF AMERICA MORTGAGES | COMPETITIVE FI PRODUCTS & ACTIVITY:COMPETITIVE FI PRODUCTS:COMPETITIVE MORTGAGES:BANK OF AMERICA MORTGAGES",
"total_ucics": 110,
"online_ucics": 64
}
]
}

Details for a single KLI

Call this API passing a FIS supplied partner_id and a KLI code to retrieve details about the KLI

Authorizations:

BearerAuthentication

path Parameters

partner_id required	integer Partner ID provided to the Financial Institution by FIS.
kli_code required	integer KLI code being searched.

Responses

200

401

Unauthorized

404

Not found

500

Server error

get/kli/v1/partners/{partner_id}/kli_details/{kli_code}

https://clarity-stage.fisglobal.com/kli/v1/partners/{partner_id}/kli_details/{kli_code}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"kli_code": 8784812,
"kli_desc": "BANK OF AMERICA MORTGAGES",
"kli_class": "PUBLIC",
"kli_is_leaf": true,
"kli_is_competitive": true,
"kli_merchant_domain": "bankofamerica.com",
"kli_merchant_logo_url": "string",
"kli_mcc_code": "string",
"kli_mcc_logo_url": "string",
"kli_relation_codes": "8784781:8847985:8847986:8849168:8784812 | 8784781:39668008:8784808:8784812",
"kli_relation_descs": "COMPETITIVE FI PRODUCTS & ACTIVITY:COMPETITIVE BANKS:COMPETITIVE DOMESTIC BANKS:BANK OF AMERICA:BANK OF AMERICA MORTGAGES | COMPETITIVE FI PRODUCTS & ACTIVITY:COMPETITIVE FI PRODUCTS:COMPETITIVE MORTGAGES:BANK OF AMERICA MORTGAGES",
"total_ucics": 110,
"online_ucics": 64
}

/merchant

Merchant name scrubbing API

Call this API passing transaction details to retrieve scrubbed merchant name, merchant classification, merchant logo (if available) and MCC logo (if available).

Authorizations:

BearerAuthentication

path Parameters

partner_id

required

integer

The partner ID provided to the financial institution by FIS

query Parameters

parser

string

Value: "VISA"

Request Body schema: application/json

The JSON Body of the POST to retrieve a scrubbed merchant name

ucic	string Unique customer identification code assigned to the customer by the Financial Institution.
uaic	string For account-based KLIs only, a unique account identification code for the account.
terminal_id	string Terminal ID assigned to the merchant POS system by credit card processor.
acquirer_id	string Acquirer ID assigned to the merchant POS system by credit card processor.
merchant_id	string Merchant ID assigned to the merchant POS system by credit card processor.
merchant_description required	string The merchant string that is to be scrubbed and classified.
mcc required	string The Merchant Classification Code for the merchant
trans_amount	number <currency> The dollar amount (USD) of the transaction
trans_timestamp	string <date-time> YYYY-MM-DD HH:MM:SS The timestamp of when the transaction was processed at the merchant POS
trans_vehicle	string Enum: "cc" "dc" "ach" The means by which the transaction was initiated. Credit Card (cc), Debit Card (dc), or ACH (ach)
trans_category	string Enum: "olb" "pos" "other" Where the transaction took place. Online banking / bill pay (olb), Point of Sale (pos), Other (other)
trans_type	string Enum: "debit" "credit" The type of transaction. Debit (debit) to the account. Credit (credit) to the account.

Responses

200

400

Bad Request

401

Unauthorized

404

Not found

500

Server error

post/merchant/v1/partners/{partner_id}/merchant

https://clarity-stage.fisglobal.com/merchant/v1/partners/{partner_id}/merchant

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"ucic": "e2c96790-fd69-11e8-9ff7-bf083b0e566c",
"uaic": "123456",
"terminal_id": "078942319",
"acquirer_id": "9345345232",
"merchant_id": "823482982839223332",
"merchant_description": "SHELL OIL              WHITE BEAR LAMNUS",
"mcc": "5541",
"trans_amount": "12.55",
"trans_timestamp": "2018-05-18T15:22:15.000Z",
"trans_vehicle": "cc",
"trans_category": "olb",
"trans_type": "debit"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"match_type": "DIRECT",
"match_score": 1,
"match_detail": 
{"merchant": 
{"classification": "SHELL",
"logo_url": "https://merchantlogos.net/shell.com.png",
"location": 
{"city": "WHITE BEAR LA",
"state": "MN",
"country": "US",
"zip": "55110"
}
},
"category_1": 
{"classification": "GASOLINE BRANDS"
},
"category_2": 
{"classification": "GASOLINE PURCHASES"
},
"mcc": 
{"classification": "SERVICE STATIONS (WITH OR WITHOUT ANCILLARY SERVICES)",
"logo_url": "https://merchantlogos.net/421702041306671bk.png"
}
},
"merchant_id": "4445001651067",
"trans_id": "0b6ffdf0-2619-4b5a-94f3-2abf0230c6cb",
"acquirer_id": "444500",
"network": "VISA"
}

Merchant Transaction Cleansing

Call this API passing transaction details to retrieve scrubbed merchant name, merchant classification, merchant logo (if available) and MCC logo (if available). MCC is an optional field in this api.

A list of sample transactions can be found here. These would values would be placed in the merchantDescription field.

Match Types

Type	Category
DIRECT	An exact match was found.
CLEANSED	No match was found. Scrubbed description returned.
MCC	No match was found. Scrubbed description returned along with MCC classification.

Authorizations:

BearerAuthentication

path Parameters

partnerId

required

integer

The partner ID provided to the financial institution by FIS

query Parameters

parser

string

Enum: "VISA" "VISA2" "custom"

A known format the transaction is in. If the value 'custom' is used the property parserDefinition of the post body is required.

consumer

boolean

A flag to use the consumer taxonomy instead of the merchant oriented one. This defaults to false (uses the merchant taxonomy).

Example

Type	Category
Merchant	WAREHOUSE CLUBS
Consumer	WAREHOUSE CLUB SHOPPER

Request Body schema: application/json

The JSON Body of the POST to retrieve a scrubbed merchant name

ucic	string Nullable Unique customer identification code assigned to the customer by the Financial Institution.
uaic	string Nullable For account-based KLIs only, a unique account identification code for the account.
terminalId	string Nullable Terminal ID assigned to the merchant POS system by credit card processor.
acquirerId	string Nullable Acquirer ID assigned to the merchant POS system by credit card processor.
merchantId	string Nullable Merchant ID assigned to the merchant POS system by credit card processor.
merchantDescription required	string The merchant string that is to be scrubbed and classified.
mcc	string Nullable The Merchant Classification Code for the merchant
transAmount	number <currency> Nullable The dollar amount (USD) of the transaction
transTimestamp	string <date-time> Nullable YYYY-MM-DD HH:MM:SS The timestamp of when the transaction was processed at the merchant POS
transVehicle	string Nullable Enum: "cc" "dc" "ach" The means by which the transaction was initiated. Credit Card (cc), Debit Card (dc), or ACH (ach)
transCategory	string Nullable Enum: "olb" "pos" "other" Where the transaction took place. Online banking / bill pay (olb), Point of Sale (pos), Other (other)
transType	string Nullable Enum: "debit" "credit" The type of transaction. Debit (debit) to the account. Credit (credit) to the account.
parserDefinition	object Nullable

Responses

200

400

Bad Request

401

Unauthorized

403

You do not have permission to access this resource.

429

You have exceeded your throughput rate or quota for your account plan.

500

Server error

post/v2/partners/{partnerId}/merchants/cleanse-transaction

https://clarity-stage.fisglobal.com/v2/partners/{partnerId}/merchants/cleanse-transaction

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"ucic": "e2c96790-fd69-11e8-9ff7-bf083b0e566c",
"uaic": "123456",
"terminalId": "078942319",
"acquirerId": "9345345232",
"merchantId": "823482982839223332",
"merchantDescription": "SHELL OIL              WHITE BEAR LAMNUS",
"mcc": "5541",
"transAmount": "12.55",
"transTimestamp": "2018-05-18T15:22:15.000Z",
"transVehicle": "cc",
"transCategory": "olb",
"transType": "debit",
"parserDefinition": 
{"maxLength": 0,
"fields": 
[
{"name": "merchant",
"start": 0,
"length": 0
}
]
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"matchType": "DIRECT",
"matchScore": 1,
"matchDetail": 
{"cleansed": "string",
"merchant": 
{"classification": "SHELL",
"logoUrl": "https://merchantlogos.net/shell.com.png"
},
"category1": 
{"classification": "GASOLINE BRANDS"
},
"category2": 
{"classification": "GASOLINE PURCHASES",
"logoUrl": "string"
},
"mcc": 
{"classification": "SERVICE STATIONS (WITH OR WITHOUT ANCILLARY SERVICES)",
"logoUrl": "https://merchantlogos.net/421702041306671bk.png"
}
}
}

/ucic

Insights and goals achieved for a single customer.

Call this API passing a FIS supplied partner_id and a UCIC and get back a list of insights and goals achieved for the customer.

Use the KLI listed in the kli_assigned as an input to the “Details for a single KLI” endpoint to obtain additional information about the specific KLI.
Use the influence_id as an input to the “Single goal achieved for a given Influence ID” endpoint to gather more details about the specific goal achieved.

Authorizations:

BearerAuthentication

path Parameters

partner_id required	integer Partner ID provided to the Financial Institution by FIS.
ucic required	string Customer being searched.

Responses

200

401

Unauthorized

404

Not found

500

Server error

get/ucic/v1/partners/{partner_id}/ucics/{ucic}

https://clarity-stage.fisglobal.com/ucic/v1/partners/{partner_id}/ucics/{ucic}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"ucic": "e2c96790-fd69-11e8-9ff7-bf083b0e566c",
"ucic_type": "I",
"ucic_is_active": true,
"goal_kli_code": 8616234,
"ucic_process_date": "Thu, 31 Jul 2014 00:00:00 GMT",
"ucic_control_id": 0.867618858348578,
"kli_assigned": 
[34426758,
10595230,
10595233
],
"campaign_influence": 
[202346
]
}

Insights and goals achieved for a group of customers.

Call this API passing a FIS supplied partner_id and query parameters to get back insights and goals achieved for a group of customers.

Use the KLI listed in the kli_assigned as an input to the “Details for a single KLI” endpoint to obtain additional information about the specific KLI.
Use the influence_id as an input to the “Single goal achieved for a given Influence ID” endpoint to gather more details about the specific goal achieved.

Authorizations:

BearerAuthentication

path Parameters

partner_id

required

integer

Partner ID provided to the Financial Institution by FIS.

query Parameters

ucic_type	string Enum: "I" "O" Indicator describing the type of customer, 'I' individual or 'O' business / organization.
ucic_is_active	string Enum: true false Flag indicating if the customer is currently an active customer of the Financial Institution.
limit	integer Number of rows to be returned per page (default 1000).
offset	integer Row number to start returning data.

Responses

200

401

Unauthorized

404

Not found

500

Server error

get/ucic/v1/partners/{partner_id}/ucics

https://clarity-stage.fisglobal.com/ucic/v1/partners/{partner_id}/ucics

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"metadata": 
{"limit": 5,
"offset": 0,
"current": "https://clarity-stage.fisglobal.com/ucic/v1/partners/12345678/ucics?ucic_type=O&ucic_is_active=TRUE&limit=10",
"next": "https://clarity-stage.fisglobal.com/ucic/v1/partners/12345678/ucics?ucic_type=O&ucic_is_active=TRUE&limit=10&offset=10"
},
"content": 
[
{"ucic": "e2c96790-fd69-11e8-9ff7-bf083b0e566c",
"ucic_type": "I",
"ucic_is_active": true,
"goal_kli_code": 8616234,
"ucic_process_date": "Thu, 31 Jul 2014 00:00:00 GMT",
"ucic_control_id": 0.867618858348578,
"kli_assigned": 
[34426758,
10595230,
10595233
],
"campaign_influence": 
[202346
]
}
]
}

ADVANCING THE WAY THE WORLD

PAYS, BANKS AND INVESTS

让我们开始对话

让我们共同努力，实现您的目标。请通过以下链接联系我们，我们的业务代表将与您联系。

向我们发送电子邮件

getinfo@fisglobal.com

打电话给我们

+1 877.776.3706

总部

Jacksonville, Florida United States

STAY CONNECTED

与我们联系

您的体验是我们的头等要务。我们随时为您提供支持。

了解详情