Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R14.0.0

Excerpt

This method is used to change the KYC profile of an existing contact information. A single contact information KYC profile can be updated in each call.

...

Name

Type

Description

token

String

The token retrieved from the login method

contact_information_identifier

(mandatory)

Contact Information Identifier  

The identifier of the contact information that should be updated. The allowed contact information identifier fields are the following:

Include Page
V4:contact_information_identifier
V4:contact_information_identifier

kyc_profile

(mandatory)

KYC Profile Identifier

The identifier of the KYC profile that should be set on the contact information. The allowed KYC profile identifier fields are the following:

Include Page
V4:kyc_profile_identifier
V4:kyc_profile_identifier

Tip

From CRM.COM R15.0.0, the parameter deprecated

fields_set
(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Input:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
"token":"{{token}}",
"contact_information_identifier":{"id_number":"654532"},
"kyc_profile":{"name":"Low"}
}

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "data": {
        "notes": null,
        "log_information": {
            "created_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "updated_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "Community",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "created_date": "2018-01-10T09:48:40",
            "updated_date": "2018-01-22T15:08:45",
            "updated_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "username": "MPAdministrator"
            },
            "created_by_user": {
                "person_name": "MPAdministrator",
                "id": "1",
                "username": "MPAdministrator"
            }
        },
        "type": "PERSON",
        "id": "10DB52E1D3174C95B56F3BAD73E306E3",
        "organizational_unit": 0,
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "privacy_level": null,
        "udf_string_1": null,
        "life_cycle_state": "FINANCIAL",
        "phones_set": [],
        "company_name": null,
        "name": "Kyriakos Parpettas",
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null,
        "udf_string_9": null,
        "relation_set": [],
        "addresses_set": [],
        "owned_by_group": {
            "alternative_code": "MG",
            "name": "Main Group",
            "description": "Main Group",
            "id": "1"
        },
        "udf_date_6": null,
        "udf_date_5": null,
        "udf_date_8": null,
        "udf_date_7": null,
        "title": null,
        "udf_date_2": null,
        "udf_date_1": null,
        "udf_date_4": null,
        "udf_date_3": null,
        "emails_set": [],
        "udf_float_5": null,
        "udf_float_6": null,
        "udf_float_3": null,
        "udf_float_4": null,
        "company_profile": {
            "tax_reference_number": null,
            "registered_in_country": null,
            "number_of_employees": null,
            "annual_turnover": null,
            "profile_year": null,
            "registration_number": null,
            "vat_registration_number": null,
            "industry_sector": null,
            "industry": null,
            "established_date": null,
            "vat_registered_by": null,
            "vat_registration_date": null
        },
        "udf_string_15": null,
        "udf_string_16": null,
        "udf_string_13": null,
        "udf_float_7": null,
        "udf_string_14": null,
        "udf_float_8": null,
        "udf_string_11": null,
        "udf_string_12": null,
        "udf_string_10": null,
        "udf_float_1": null,
        "first_name": "Kyriakos",
        "udf_float_2": null,
        "preferred_language": null,
        "last_name": "Parpettas",
        "middle_name": null,
        "authorization_settings": {
            "direct_marketing_setting_updated_by_user": {
                "person_name": "MPAdministrator",
                "id": "1",
                "username": "MPAdministrator"
            },
            "affiliate_marketing_setting_updated_by_user": {
                "person_name": "MPAdministrator",
                "id": "1",
                "username": "MPAdministrator"
            },
            "affiliate_marketing_setting_updated_date": "2018-01-10T09:48:40",
            "send_affiliate_marketing_material": false,
            "send_direct_marketing_material": false,
            "direct_marketing_setting_updated_date": "2018-01-10T09:48:40"
        },
        "category": null,
        "kyc_profile": {
            "kyc_profile_state": "PENDING",
            "kyc_profile_name": "Low",
            "kyc_profile_expiration_date": null
        },
        "demographics": {
            "id_number": "654532",
            "gender": null,
            "country_of_residence": {
                "alternative_code": "CYP",
                "three_character_code": "CYP",
                "name": "CYPRUS",
                "id": "181",
                "two_character_code": "CY"
            },
            "date_of_birth": {
                "month": null,
                "year": null,
                "day": null
            },
            "industry_sector": null,
            "industry": null,
            "name_day": {
                "month": null,
                "day": null
            },
            "passport_number_expiration_date": "2018-01-19T08:18:31",
            "id_number_expiration_date": "2018-01-19T09:09:50",
            "passport_number": null,
            "social_security_number": null,
            "id_issued_by_country": null,
            "passport_issued_by_country": null
        }
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}