Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved user |
| username | String | The username of the retrieved user |
| active | ||
| domain | ||
| developer | ||
| sales_user | ||
| cti_enabled | String | Indicates whether the user's account is CTI enabled or not |
| cti_phone_extension_number | String | The extension number of the phone device of this user and only if the user's account is CTI enabled |
| ip_address | ||
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| contact_information | Contact Information Object | The user's related Contact Information |
Log Information Object | The log information related with the retrieved user | |
| security_profile | Security Profile Object | The user's Security Profile |
Referred Objects Response Data
- POST contact_information/withdraw_consent — This method is used so that Contacts can withdraw Consent
- GET contact_information/show — This method returns information related with a contact information. Single contact information is returned by each call
- POST contact_information/accept_consent — This method is used so that Contacts can accept Consent, providing an attachment on the Contact (optionally) representing the Consent Form. This Web API method requires a multipart/form-data post, as defined in RFC 1867. There are many libraries available that can be used in order to submit multipart/form-data posts (for example MultipartEntity http://hc.apache.org/httpcomponents-client-ga/httpmime/apidocs/org/apache/http/entity/mime/MultipartEntity.html in Java). A single attachment can be adde
- POST contact_information/create — This method creates a contact information. Single contact information can be created by each call. All addresses, phones and emails which are added on the contact information are added as active
- POST contact_information/reject_consent — This method is used so that Contacts can reject Consent
- GET contact_information/list — This method returns information related with contact information. Multiple contact information can be returned by each call
- contact_information/configuration
- GET contact_information/configuration/categories/list — This method returns the contact information categories that are allowed to be used in the system. Multiple contact information categories are returned by each call
- GET contact_information/configuration/industry_sectors/list — This method returns the industry sectors that are allowed to be used in the system. Multiple industry sectors are returned by each call
- GET contact_information/configuration/email_types/list — This method returns the email types that are allowed to be used in the system, as specified in the active contact information definition. Multiple email types are returned by each call
- GET contact_information/configuration/phone_types/list — This method returns the phone types that are allowed to be used in the system, as specified in the active contact information definition. Multiple phone types are returned by each call
- GET contact_information/configuration/kyc_profiles/list — This method returns the KYC profiles that are allowed to be used in the system, as specified in the active KYC Definition. Multiple KYC profiles are returned by each call
- GET contact_information/configuration/industries/list — This method returns the industries that are allowed to be used in the system. Multiple industries are returned by each call
- GET contact_information/configuration/relation_types/list — This method returns the relation types that are allowed to be used in the system, as specified in the active contact information definition. Multiple relation types are returned by each call
- GET contact_information/configuration/address_types/list — This method returns the address types that are allowed to be used in the system, as specified in the active contact information definition. Multiple address types are returned by each call
- POST contact_information/profile_photo/remove — This method is used to remove the profile photo from a specific contact information. A single contact information can be updated through this method
- POST contact_information/profile_photo/add — This method is used to add a profile photo on an existing contact information. This Web API method requires a multipart/form-data post, as defined in RFC 1867. There are many libraries available that can be used in order to submit multipart/form-data posts (for example MultipartEntity http://hc.apache.org/httpcomponents-client-ga/httpmime/apidocs/org/apache/http/entity/mime/MultipartEntity.html in Java). A single contact information can be updated through each call
- GET contact_information/profile_photo/view — This method returns the profile photo information related with a contact information
- POST contact_information/verify_kyc_profile — This method is used to set the KYC profile of an existing contact information into Verified life cycle state. A single contact information KYC profile can be verified in each call.
- POST contact_information/change_kyc_profile — 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.
- POST contact_information/update — This method update a contact information. Single contact information can be updated by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null. All addresses, phones and emails which are added on the contact information are added as active
- contact_information/validate
- GET contact_information/validate_company_tax_reference_number — This method returns if the company TAX reference number is in a valid format
- GET contact_information/validate_social_security_number — This method returns if the social security number is in a valid format
- GET contact_information/validate_company_registration_number — This method returns if the company registration number is in a valid format
- GET contact_information/validate_person_id_number — This method returns if the person id number is in a valid format
- GET contact_information/validate_address_post_code — This method returns if the address post code is in a valid format
- GET contact_information/validate_passport_number — This method returns if the passport number is in a valid format
- GET contact_information/validate_company_vat_number — This method returns if the company VAT number is in a valid format
- GET contact_information/validate_phone_number — This method returns if the phone number is in a valid format
- GET contact_information/validate_address_pobox_post_code — This method returns if the address post code is in a valid format
- POST contact_information/refute_kyc_profile — This method is used to set the KYC profile of an existing contact information into Refute life cycle state. A single contact information KYC profile can be verified in each call.