| _embedded | object | "_embedded" subdivides into: 1 - "contacts" (
array[object]) - list of contacts.
1.1 - "confidence_score" (number) - confidence score based on the contact search. Required.
1.2 - "contact" (object) - object details. Required.
1.2.1 - "id" (string) - the contact ID from the external FSI institution (the ID must be used as the identifier of the contact, to get its accounts, cards, payments and transactions). Required.
1.2.2 - "member_id" (string) - an identifier of the contact in the external FSI institution, for some cores it can be social_security, or other contact property, or even equal to the ID. Don't use this property as the contact identifier to get its accounts, cards, payments and transactions). Required.
1.2.3 - "name" (string) - contact name. Required.
1.2.4 - "contacts" (array[object]
) - required.
1.2.4.1 - "id" (string) - identification for contact point. Required.
1.2.4.2 - "type" (string) - define the type for this contact point. Allowed values: "PHONE",
"EMAIL", "SMS", "OTHER". Required.
1.2.4.3 - "value" (string) - the actual contact point details. Required.
1.2.4.4 - "use" (string) - purpose of this contact point. Allowed values:
"HOME", "WORK", "MOBILE", "TEMPORARY",
"OLD". Required.
1.2.4.5 - "rank" (integer) - specify preferred order of use (0 = highest); >= 0. Required.
1.2.5 - "addresses" (array[object]
) - required.
1.2.5.1 - "id" (string) - identification for the address.
1.2.5.2 - "type" (string) - address type. Allowed values: "POSTAL",
"PHYSICAL", "BOTH".
1.2.5.3 - "street" (string) - street name address (can be Street, Avenue, Square, etc.).
1.2.5.4 - "city" (string) - name of city, town etc.
1.2.5.5 - "district" (string) - district name (aka county).
1.2.5.6 - "district" (string) - district name (aka county).
1.2.5.7 - "state" (string) - sub-unit of country (abbreviations are ok).
1.2.5.8 - "postal_code" (string)
1.2.5.9 - "country" (string) - country (e.g. can be ISO 3166 2 or 3-letter code).
1.2.6 - "id_document_number" (string) - document number associated to a person.
1.2.7 - "id_document_type" (string) - document number associated to a person. Allowed values:
"SOCIAL_SECURITY",
"DRIVER_LICENSE",
"PASSPORT", "NATIONAL_ID", "OTHER".
1.2.8 - "birth_date" (string<date>) - required.
1.2.9 - "_links" (object) - self link item for HAL.
1.2.9.1 - "self" (object) - link of the current page. Required.
1.2.9.1.1 - "href" (string) - address of the resource. 2 - "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. | yes |
