openapi: 3.0.0
info:
version: 1.0.0
title: Segmint Data Services API
description: "#### KLI\nRetrieve detailed information about:\n- The insights (Key Lifestyle Indicators KLIs) that
are assigned to a single UCIC of the Financial Institution.\n- The list of customers
(UCICs) that have a single KLI assignment in common, including the other KLIs
assigned to each customer.\n- Descriptive details for all KLIs assigned to the
customers of the Financial Institution.\n- Descriptive details for a specific
KLI within the Segmint KLI taxonomy, including the count of customers assigned
and the list of parent KLIs.\n- Retrieve the list of KLI that are categorized
within a group (defined as children) of the Segmint KLI taxonomy. \n\n\n#### Integrations\n
When integrating with Segmint's APIs you should always allow for unknown fields.
Segmint reserves the right to add additional fields to its APIs. Segmint 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.\n\nAccess to API endpoints
may be rate limited and have monthly account level quotas, your account representative
will have details if this applies to you.\n\n\n\nClick here to find out more about."
servers:
- url: https://dataservices-demo.segmint.net/
- url: https://dataservices-stage.segmint.net
- url: https://dataservices.segmint.net/
paths:
"/kli/v1/partners/{partner_id}/ucics/{ucic}/kli_assignments":
get:
summary: List of KLIs assigned to a customer
description: |-
'Call this API passing a Segmint 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 Segmint 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.'
### Fields marked with an * are required.
responses:
'200':
description: Ok
content:
"*/*":
schema:
"$ref": "#/components/schemas/UCICKLIDetail"
'401':
"$ref": "#/components/responses/UnauthorizedError"
'404':
description: Not found
'500':
description: Server error
security:
- BearerAuthentication: []
parameters:
- name: partner_id
in: path
required: true
description: Partner ID provided to the Financial Institution by Segmint.
schema:
type: integer
- name: ucic
in: path
required: true
description: UCIC of the Financial Institution customer for which you wish
to receive the set insights (KLIs) assigned.
schema:
type: string
- name: kli_class
in: query
description: Indicator describing the privacy of the KLI, Public or Private
to the Financial Institution.
schema:
type: string
enum:
- PUBLIC
- PRIVATE
- name: kli_is_competitive
in: query
description: Flag (Y/N) indicating if the KLI describes a customer insight
related to activity with competitive Financial Institutions.
schema:
type: boolean
enum:
- true
- false
- name: kli_is_leaf
in: query
description: Flag (Y/N) indicating if the KLI is at the lowest level of the
Segmint KLI taxonomy (no children KLIs exist).
schema:
type: boolean
- name: kli_is_active
in: query
description: Flag (Y/N) indicating if the KLIs are active for the customers
schema:
type: boolean
tags:
- "/kli"
"/kli/v1/partners/{partner_id}/kli_assignments/{kli_code}/children":
get:
summary: List of KLIs within a group(section) of the KLI taxonomy for all customers
description: |-
'Call this API passing a Segmint 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|
**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 Segmint 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.'
### Fields marked with an * are required.
responses:
'200':
description: Ok
content:
"*/*":
schema:
"$ref": "#/components/schemas/ChildrenKLIDetailAll"
'401':
"$ref": "#/components/responses/UnauthorizedError"
'404':
description: Not found
'500':
description: Server error
security:
- BearerAuthentication: []
parameters:
- name: partner_id
in: path
required: true
description: Partner ID provided to the Financial Institution by Segmint
schema:
type: integer
- name: kli_code
in: path
required: true
description: KLI code being searched.
schema:
type: integer
- name: kli_class
in: query
description: Indicator describing the privacy of the KLI, Public or Private
to the Financial Insitution.
schema:
type: string
enum:
- PUBLIC
- PRIVATE
- name: kli_is_competitive
in: query
description: Flag (Y/N) indicating if the KLI describes a customer insight
related to activity competitive Financial Institution.
schema:
type: boolean
enum:
- true
- false
- name: kli_is_leaf
in: query
description: Flag (Y/N) indicating if the KLI is at the lowest level of the
Segmint KLI taxonomy (no children KLIs exist).
schema:
type: boolean
enum:
- true
- false
- name: limit
in: query
description: Number of rows to be returned per page (default 1000).
schema:
type: integer
- name: offset
in: query
description: Starting row number for this page of data.
schema:
type: integer
tags:
- "/kli"
"/kli/v1/partners/{partner_id}/ucics/{ucic}/kli_assignments/{kli_code}/children":
get:
summary: List of KLIs within a group(section) of the KLI taxonomy
description: |
Call this API passing
a Segmint 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|
**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 Segmint 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.
### Fields marked with an * are required.
responses:
'200':
description: Ok
content:
"*/*":
schema:
"$ref": "#/components/schemas/ChildrenKLIDetailSingle"
'401':
"$ref": "#/components/responses/UnauthorizedError"
'404':
description: Not found
'500':
description: Server error
security:
- BearerAuthentication: []
parameters:
- name: partner_id
in: path
required: true
description: Partner ID provided to the Financial Institution by Segmint
schema:
type: integer
- name: ucic
in: path
required: true
description: UCIC of the Financial Institution customer for which you wish
to receive the set insights (KLIs) assigned.
schema:
type: string
- name: kli_code
in: path
required: true
description: KLI code being searched.
schema:
type: integer
- name: kli_class
in: query
description: Indicator describing the privacy of the KLI, Public or Private
to the Financial Insitution.
schema:
type: string
enum:
- PUBLIC
- PRIVATE
- name: kli_is_competitive
in: query
description: Flag (Y/N) indicating if the KLI describes a customer insight
related to activity competitive Financial Institution.
schema:
type: boolean
enum:
- true
- false
- name: kli_is_leaf
in: query
description: Flag (Y/N) indicating if the KLI is at the lowest level of the
Segmint KLI taxonomy (no children KLIs exist).
schema:
type: boolean
enum:
- true
- false
tags:
- "/kli"
"/kli/v1/partners/{partner_id}/kli_assignments/{kli_code}/ucic_details":
get:
summary: List of customers assigned a given KLI
description: |-
Call
this API passing a Segmint 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.
### Fields marked with an * are required.
responses:
'200':
description: Ok
content:
"*/*":
schema:
"$ref": "#/components/schemas/KLIUCICDetail"
'401':
"$ref": "#/components/responses/UnauthorizedError"
'404':
description: Not found
'500':
description: Server error
security:
- BearerAuthentication: []
parameters:
- name: partner_id
in: path
required: true
description: Partner ID provided to the Financial Institution by Segmint.
schema:
type: integer
- name: kli_code
in: path
required: true
description: KLI code being searched.
schema:
type: integer
- name: ucic_type
in: query
description: Indicator describing the type of customer, 'I' individual or
'O' business / organization.
schema:
type: string
enum:
- I
- O
- name: ucic_is_active
in: query
description: Flag indicating if the customer is currently an active customer
of the Financial Institution.
schema:
type: string
enum:
- true
- false
- name: limit
in: query
description: Number of rows to be returned per page (default 1000).
schema:
type: integer
- name: offset
in: query
description: Row number to start returning data.
schema:
type: integer
tags:
- "/kli"
"/kli/v1/partners/{partner_id}/kli_details":
get:
summary: Details for all KLIs assigned to FI customers
description: |-
'Call this API passing a Segmint 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 Segmint 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.'
### Fields marked with an * are required.
responses:
'200':
description: Ok
content:
"*/*":
schema:
"$ref": "#/components/schemas/MultipleKLIDetail"
'401':
"$ref": "#/components/responses/UnauthorizedError"
'404':
description: Not found
'500':
description: Server error
security:
- BearerAuthentication: []
parameters:
- name: partner_id
in: path
required: true
description: Partner ID provided to the Financial Institution by Segmint.
schema:
type: integer
- name: kli_class
in: query
description: Indicator describing the privacy of the KLI, Public or Private
to the Financial Institution.
schema:
type: string
enum:
- PUBLIC
- PRIVATE
- name: kli_is_competitive
in: query
description: Flag (Y/N) indicating if the KLI describes a customer insight
related to activity with competitive Financial Institutions.
schema:
type: boolean
enum:
- true
- false
- name: kli_is_leaf
in: query
description: Flag (Y/N) indicating if the KLI is at the lowest level of the
Segmint KLI taxonomy (no children KLIs exist).
schema:
type: boolean
enum:
- true
- false
- name: limit
in: query
description: Number of rows to be returned per page (default 1000).
schema:
type: integer
- name: offset
in: query
description: Row number to start returning data.
schema:
type: integer
tags:
- "/kli"
"/kli/v1/partners/{partner_id}/kli_details/{kli_code}":
get:
summary: Details for a single KLI
description: |-
Call
this API passing a Segmint supplied partner_id and a KLI code to retrieve
details about the KLI.
### Fields marked with an * are required.
responses:
'200':
description: Ok
content:
"*/*":
schema:
"$ref": "#/components/schemas/SingleKLIDetail"
'401':
"$ref": "#/components/responses/UnauthorizedError"
'404':
description: Not found
'500':
description: Server error
security:
- BearerAuthentication: []
parameters:
- name: partner_id
in: path
required: true
description: Partner ID provided to the Financial Institution by Segmint.
schema:
type: integer
- name: kli_code
in: path
required: true
description: KLI code being searched.
schema:
type: integer
tags:
- "/kli"
components:
responses:
UnauthorizedError:
description: Unauthorized
BadRequest:
description: Bad Request. Check your credentials
BadPasswordUpperCase:
description: 'Password did not conform with policy: Password must have uppercase
characters'
BadPasswordLowerCase:
description: 'Password did not conform with policy: Password must have lowercase
characters'
BadPasswordLength:
description: New password must have a length greater than 8
BadPasswordSpecial:
description: 'Password did not conform with policy: Password must have symbol
characters'
content:
application/json:
schema:
"$ref": "#/components/schemas/PasswordErrors"
ToManyRequests:
description: You have exceeded your throughput rate or quota for your account
plan.
Forbidden:
description: You do not have permission to access this resource.
securitySchemes:
BearerAuthentication:
type: http
description: Obtain a token using the /auth/v1/token endpoint
scheme: bearer
bearerFormat: JWT
schemas:
UCICKLIDetail:
properties:
kli_code:
type: integer
description: Unique code for the Key Lifestyle Indicator (KLI).
example: 8850775
kli_is_active:
type: boolean
description: Flag indicating if the KLI is currently active.
example: true
kli_class:
type: string
description: Flag indicating the privacy of the KLI, Public or Private to
the Financial Institution.
example: PUBLIC
kli_categorization:
type: string
description: For leaf KLIs only, provides one level of KLI categorization.
example: OTHER COMPETITIVE BANKING TRANSACTIONS
kli_description:
type: string
description: Description of the KLI.
example: MISC. TRANSACTION FEE
kli_is_competitive:
type: boolean
description: Flag (Y/N) indicating if the KLI describes a customer insight
related to activity with competitive Financial Institution.
example: true
kli_is_leaf:
type: boolean
description: Flag (Y/N) indicating if the KLI is at the lowest level of
the Segmint KLI taxonomy (no children KLIs exist).
example: true
primary_attribute:
type: string
description: Short description indicating the value attributing to KLI assignment
(if available).
primary_owner:
type: boolean
description: For account-based KLIs only, flag indicating if the customer
is the primary owner of the account
example: true
uaic:
type: string
description: For account-based KLIs only, a unique account identification
code for the account.
uaic_close_date:
type: string
description: For account-based KLIs only, an account closed date (YYYY-MM-DD)
for the customer.
uaic_open_date:
type: string
description: For account-based KLIs only, an account open date (YYYY-MM-DD)
for the customer.
ChildrenKLIDetailSingle:
properties:
kli_code:
type: integer
description: Unique code for the Key Lifestyle Indicator (KLI).
example: 8850775
kli_is_active:
type: boolean
description: Flag indicating if the KLI is currently active.
example: true
kli_class:
type: string
description: Flag indicating the privacy of the KLI, Public or Private to
the Financial Institution.
example: PUBLIC
kli_categorization:
type: string
description: For leaf KLIs only, provides one level of KLI categorization.
example: OTHER COMPETITIVE BANKING TRANSACTIONS
kli_description:
type: string
description: Description of the KLI.
example: MISC. TRANSACTION FEE
kli_is_competitive:
type: boolean
description: Flag (Y/N) indicating if the KLI describes a customer insight
related to activity with competitive Financial Institution.
example: true
kli_is_leaf:
type: boolean
description: Flag (Y/N) indicating if the KLI is at the lowest level of
the Segmint KLI taxonomy (no children KLIs exist).
example: true
primary_attribute:
type: string
description: Short description indicating the value attributing to KLI assignment
(if available).
primary_owner:
type: boolean
description: For account-based KLIs only, flag indicating if the customer
is the primary owner of the account
example: true
uaic:
type: string
description: For account-based KLIs only, a unique account identification
code for the account.
uaic_close_date:
type: string
description: For account-based KLIs only, an account closed date (YYYY-MM-DD)
for the customer.
uaic_open_date:
type: string
description: For account-based KLIs only, an account open date (YYYY-MM-DD)
for the customer.
ChildrenKLIDetailAll:
properties:
metadata:
type: object
properties:
limit:
type: integer
description: Number of rows to be returned per page for this query
example: 5
offset:
type: integer
description: Starting row number for this page of data.
example: 0
current:
type: string
description: URL for the current page of data.
example: https://dataservices-demo.segmint.net/kli/v1/partners/12345678/kli_assignments/39668008/children?kli_class=PUBLIC&kli_is_leaf=TRUE&ucic=000c6b38-7411-43d4-b794-f98ae1a0b14a&limit=100
next:
type: string
description: URL for the next page of data.
example: https://dataservices-demo.segmint.net/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:
type: integer
description: Number of rows returned on the current page of data.
example: 5
content:
type: array
items:
type: object
properties:
kli_code:
type: integer
description: Unique code for the Key Lifestyle Indicator (KLI).
example: 8850775
kli_is_active:
type: boolean
description: Flag indicating if the KLI is currently active.
example: true
kli_class:
type: string
description: Flag indicating the privacy of the KLI, Public or Private
to the Financial Institution.
example: PUBLIC
kli_categorization:
type: string
description: For leaf KLIs only, provides one level of KLI categorization.
example: OTHER COMPETITIVE BANKING TRANSACTIONS
kli_description:
type: string
description: Description of the KLI.
example: MISC. TRANSACTION FEE
kli_is_competitive:
type: boolean
description: Flag (Y/N) indicating if the KLI describes a customer
insight related to activity with competitive Financial Institution.
example: true
kli_is_leaf:
type: boolean
description: Flag (Y/N) indicating if the KLI is at the lowest level
of the Segmint KLI taxonomy (no children KLIs exist).
example: true
primary_attribute:
type: string
description: Short description indicating the value attributing to
KLI assignment (if available).
primary_owner:
type: boolean
description: For account-based KLIs only, flag indicating if the customer
is the primary owner of the account
example: true
ucic:
type: string
description: Unique customer identification code assigned to the customer
by the Financial Institution.
example: e2c96790-fd69-11e8-9ff7-bf083b0e566c
uaic:
type: string
description: For account-based KLIs only, a unique account identification
code for the account.
uaic_close_date:
type: string
description: For account-based KLIs only, an account closed date (YYYY-MM-DD)
for the customer.
uaic_open_date:
type: string
description: For account-based KLIs only, an account open date (YYYY-MM-DD)
for the customer.
KLIUCICDetail:
properties:
metadata:
type: object
properties:
limit:
type: integer
description: Number of rows to be returned per page for this query.
example: 5
offset:
type: integer
description: Starting row number for this page of data.
example: 0
current:
type: string
description: URL for the current page of data.
example: https://dataservices-demo.segmint.net/kli/v1/partners/12345678/kli_assignments/8784812/ucic_details?ucic_type=O&limit=5
next:
type: string
description: URL for the next page of data.
example: https://dataservices-demo.segmint.net/kli/v1/partners/12345678/kli_assignments/8784812/ucic_details?ucic_type=O&limit=5&offset=5
page_total:
type: integer
description: Number of rows returned on the current page of data.
example: 5
content:
type: array
items:
type: object
properties:
ucic:
type: string
description: Unique customer identification code assigned to the customer
by the Financial Institution.
example: e2c96790-fd69-11e8-9ff7-bf083b0e566c
ucic_type:
type: string
description: Indicator describing the type of customer, 'I' individual
or 'O' business / organization.
example: I
ucic_is_active:
type: boolean
description: Flag indicating if the customer is currently an active
customer of the Financial Institution.
example: true
ucic_process_date:
type: string
description: Date (YYYY-MM-DD) the customer was first analyzed for
KLI assignment by Segmint
example: Thu, 01 Jan 2015 00:00:00 GMT
ucic_control_id:
type: integer
description: Unique ID assigned to the customer that can be used by
the FI for data analytics.
example: 0.466580814216286
kli_assigned:
type: array
items:
type: integer
description: Full list of KLIs (codes) currently assigned to a customer.
example:
- 33355203
- 83202517
- 83202560
- 12070221
- 10595230
- 13638284
- 34426081
MultipleKLIDetail:
properties:
metadata:
type: object
properties:
limit:
type: integer
description: Number of rows to be returned per page for this query.
example: 5
offset:
type: integer
description: Starting row number for this page of data.
example: 0
current:
type: string
description: URL for the current page of data.
example: https://dataservices-demo.segmint.net/kli/v1/partners/12345678/kli_details?kli_is_leaf=TRUE&kli_class=PRIVATE&limit=40
next:
type: string
description: URL for the next page of data.
example: https://dataservices-demo.segmint.net/kli/v1/partners/12345678/kli_details?kli_class=PRIVATE&kli_is_leaf=TRUE&limit=40&offset=40
page_total:
type: integer
description: Number of rows returned on the current page of data.
example: 5
content:
type: array
items:
type: object
properties:
kli_code:
type: integer
description: Unique code for the Key Lifestyle Indicator (KLI).
example: 8784812
kli_desc:
type: string
description: Text description of the KLI.
example: BANK OF AMERICA MORTGAGES
kli_class:
type: string
description: Flag indicating the privacy of the KLI, Public or Private
to the Financial Institution.
example: PUBLIC
kli_is_leaf:
type: boolean
description: Flag (Y/N) indicating if the KLI is at the lowest level
of the Segmint KLI taxonomy (no children KLIs exist).
example: true
kli_is_competitive:
type: boolean
description: Flag (Y/N) indicating if the KLI describes a customer
insight related to activity with competitive Financial Institution.
example: true
kli_merchant_domain:
type: string
description: Domain name for the merchant (if available).
example: bankofamerica.com
kli_merchant_logo_url:
type: string
description: URL to access merchant logo (if available).
kli_mcc_code:
type: string
description: Industry standard Merchant Classification Code for the
merchant (if available).
kli_mcc_logo_url:
type: string
description: URL to access an MCC logo (if available).
kli_relation_codes:
type: string
description: An ordered list of KLIs (codes) representing the parents
of the given KLI. Multiple sets of parent groupings are pipe delimited.
example: 8784781:8847985:8847986:8849168:8784812 | 8784781:39668008:8784808:8784812
kli_relation_descs:
type: string
description: An ordered list of KLIs (descriptions) representing the
parents of the given KLI. Multiple sets of parent groupings are
pipe delimited.
example: 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:
type: integer
description: Total count of customers that have been assigned the
given KLI.
example: 110
online_ucics:
type: integer
description: Total count of customers that have been assigned the
given KLI and are also assigned the Online Banking KLI.
example: 64
SingleKLIDetail:
properties:
kli_code:
type: integer
description: Unique code for the Key Lifestyle Indicator (KLI).
example: 8784812
kli_desc:
type: string
description: Description of the KLI.
example: BANK OF AMERICA MORTGAGES
kli_class:
type: string
description: Flag indicating the privacy of the KLI, Public or Private to
the Financial Institution.
example: PUBLIC
kli_is_leaf:
type: boolean
description: Flag (Y/N) indicating if the KLI is at the lowest level of
the Segmint KLI taxonomy (no children KLIs exist).
example: true
kli_is_competitive:
type: boolean
description: Flag (Y/N) indicating if the KLI describes a customer insight
related to activity with competitive Financial Institution.
example: true
kli_merchant_domain:
type: string
description: Domain name for the merchant (if available).
example: bankofamerica.com
kli_merchant_logo_url:
type: string
description: URL to access merchant logo (if available).
kli_mcc_code:
type: string
description: Industry standard Merchant Classification Code for the merchant
(if available).
kli_mcc_logo_url:
type: string
description: URL to access an MCC logo (if available).
kli_relation_codes:
type: string
description: An ordered list of KLIs (codes) representing the parents of
the given KLI. Multiple sets of parent groupings are pipe delimited.
example: 8784781:8847985:8847986:8849168:8784812 | 8784781:39668008:8784808:8784812
kli_relation_descs:
type: string
description: An ordered list of KLIs (descriptions) representing the parents
of the given KLI. Multiple sets of parent groupings are pipe delimited.
example: 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:
type: integer
description: Total count of customers that have been assigned the given
KLI.
example: 110
online_ucics:
type: integer
description: Total count of customers that have been assigned the given
KLI and are also assigned the Online Banking KLI.
example: 64