_embedded
object
required
contacts
array[object]
required
List of contacts id
string
required
The contact id from the extenal fsi institution (id which SHOULD BE USEED as the identified of the contact, to get its accounts, cards, payments and transactions). member_id
string
required
An identifier of the contact in the extenal fsi institution, for some cores it can be SOCIAL_SECURITY, or other contact property, or even equal to the id. (DO NOT USE this property as the contact identifier to get its accounts, cards, payments and transactions) name
string
required
Contact name contacts
array[object]
required
id
string
required
Identification for contact point type
string
required
Define the type for this contact point Allowed values:
PHONE
EMAIL
SMS
OTHER
value
string
required
The actual contact point details use
string
required
Purpose of this contact point Allowed values:
HOME
WORK
MOBILE
TEMPORARY
OLD
rank
integer
required
Specify preferred order of use (0 = highest)
= 0
addresses
array[object]
required
id
string
required
Identification for the addresstype
string
required
Address typeAllowed values:
POSTAL
PHYSICAL
BOTH
street
string
required
Street name address (can be Street, Avenue, Square, etc.)
city
string
required
Name of city, town etc. district
string
required
District name (aka county) state
string
required
Sub-unit of country (abbreviations ok) postal_code
string
required
country
string
required
Country (e.g. can be ISO 3166 2 or 3 letter code) id_document_number
string
Document number associated to a person id_document_type
string
Allowed values:
SOCIAL_SECURITY
DRIVERS_LICENSE
PASSPORT
NATIONAL_ID
OTHER
birth_date
string<date>
vip_client
boolean
Indicates if the contact is sensitive and some of his data should be hidden from agents custom_fields
array[object]
Custom fields list. It allows the core the retrieve custom data for each FSI contact. Example:
[{"key":"Job","value":"Engineer"},{"key":"Nationality","value":"American"}]
key
string
required
custom field name value
string
custom field value id_documents
array[object]
ID Documents associated to a person. The array is ordered as follows (from top to bottom), first SOCIAL_SECURITY, then DRIVERS_LICENSE, then PASSPORT, then NATIONAL_ID and finally OTHER. number
string
Document number associated to a person type
string
required
Allowed values:
SOCIAL_SECURITY
DRIVERS_LICENSE
PASSPORT
NATIONAL_ID
OTHER membership_date
string<date>
Date on that client became a member/client _links
object
required
Self link item for HAL self
object
required
Link of the current page href
string
Address of the resource redacted_fields
array[string]
list of fields in the response which are redacted. Each element is the full path access in the response of the redacted field. | 