Select
Schemas
ConsentId
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | Consent definition unique identifier (normalized to uppercase without spaces and special characters) |
ConsentType
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | Consent statement choice type list: * ACCEPTANCE - Text written in affirmative. May be in pending state* OPPOSITION - Text written in negative. It cannot be in pending state and must be represented with a checkbox |
ConsentChoice
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | integer | false | Consent statement choice list: * 0 - Consent accepted* 1 - Consent choice unknown* 2 - Consent rejected |
Language
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | Language in locale in RFC 5646 format (defined in RFC 5646, which rely on the ISO 639). Ex: es, ca, eu, en, fr |
UserType
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | Type of users the consent tree applies to |
ConsentDetails
|
|
Name | Type | Required | Description |
---|---|---|---|
language | Language | true | Language in locale in RFC 5646 format (defined in RFC 5646, which rely on the ISO 639). Ex: es, ca, eu, en, fr |
text | string | true | Full text of the consent |
description | string | true | Detailed description of the consent |
short_text | string | true | Shortened version of the consent text |
SellChannel
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | Starting point of the user consent acquisition Sell channel list: * app - App portfolio client* appPopup - App portfolio client popup* ecare - Private client area* ecarePopup - Private client area popup* eshop - Online web store acquisition client* lpemail - Email campaign landing page* lpsms - Sms campaign landing page* mycrm - Post sales portal, non presential phone sale* mycrmPopup - Post sales portal, non presential phone sales for portfolio clients* myventa - Sales portal, non presential phone sale* pos - Presential sale, seles portal in store* renuevo - Existing client, hiring another terminal* televenta - Sales portal, non presential phone sale* topUps - Presential sale, prepaid recharge machine in store* vista - CRM postsale* vistaPopup - CRM popup postsale* webdealer - Sales portal, presential, sale in store |
UserSegment
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | Regulated sector where user belongs to. Allowed values: telco, energy |
GetConsentsResponse
|
|
Name | Type | Required | Description |
---|---|---|---|
statements | [GetConsentStatement] | true | Tree structure for consents and default choices where keys are identifiers |
locale | string | true | Locale. If text is not found, locale will be the organization default locale |
PostConsentsResponse
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string(uuid) | true | User consents unique identifier at Mas Consents |
GetConsentStatement
|
|
Name | Type | Required | Description |
---|---|---|---|
id | ConsentId | true | Consent definition unique identifier (normalized to uppercase without spaces and special characters) |
choice | integer | true | Consent statement choice list: * 0 - Consent accepted* 1 - Consent choice unknown* 2 - Consent rejected |
choice_type | ConsentType | true | Consent statement choice type list: * ACCEPTANCE - Text written in affirmative. May be in pending state* OPPOSITION - Text written in negative. It cannot be in pending state and must be represented with a checkbox |
text | string | true | Consent statement text |
description | string | true | Consent text description |
child_statements | [GetConsentStatement] | true | Nested user consent statements |
PostConsentsCustomerRequest
|
|
Name | Type | Required | Description |
---|---|---|---|
actor_id | string | true | Information about what agent/system/user is setting consents |
selections | [UserConsentSelection] | true | User cosents choices, in array format, chosen by the user |
ip | string | true | IP address of the actor who modifies the user consents When the actor is, directly, the client who modifies their consents, it is important that ip is client ip address and not any kind of middleware system ip |
sell_channel | SellChannel | true | Starting point of the user consent acquisition Sell channel list: * app - App portfolio client* appPopup - App portfolio client popup* ecare - Private client area* ecarePopup - Private client area popup* eshop - Online web store acquisition client* lpemail - Email campaign landing page* lpsms - Sms campaign landing page* mycrm - Post sales portal, non presential phone sale* mycrmPopup - Post sales portal, non presential phone sales for portfolio clients* myventa - Sales portal, non presential phone sale* pos - Presential sale, seles portal in store* renuevo - Existing client, hiring another terminal* televenta - Sales portal, non presential phone sale* topUps - Presential sale, prepaid recharge machine in store* vista - CRM postsale* vistaPopup - CRM popup postsale* webdealer - Sales portal, presential, sale in store |
trace_id | string | true | Trazability info |
capture_date | string(date-time) | true | none |
GetUserMetadataResponse
|
|
Name | Type | Required | Description |
---|---|---|---|
customer_id | string | true | The customer identifier at CRM |
impact | boolean | true | Define if user it is an impactable user. This is the field that will be taken into account for the launch of campaigns or popups for the capture of consents |
UserConsentSelection
|
|
Name | Type | Required | Description |
---|---|---|---|
id | ConsentId | true | Consent definition unique identifier (normalized to uppercase without spaces and special characters) |
choice | ConsentChoice | true | Consent statement choice list: * 0 - Consent accepted* 1 - Consent choice unknown* 2 - Consent rejected |
CreateConsentRequest
|
|
Name | Type | Required | Description |
---|---|---|---|
id | ConsentId | true | Consent definition unique identifier (normalized to uppercase without spaces and special characters) |
type | ConsentType | true | Consent statement choice type list: * ACCEPTANCE - Text written in affirmative. May be in pending state* OPPOSITION - Text written in negative. It cannot be in pending state and must be represented with a checkbox |
consent | [ConsentDetails] | true | Array of consent details for different locales |
SavedConsentResponse
|
|
Name | Type | Required | Description |
---|---|---|---|
id | ConsentId | true | Consent definition unique identifier (normalized to uppercase without spaces and special characters) |
languages | [string] | true | List of languages supported by the consent |
UpdateConsentRequest
|
|
Name | Type | Required | Description |
---|---|---|---|
consent | [ConsentDetails] | true | none |
changes_description | string | false | Optional description of the changes made |
CreateConsentTreeRequest
|
|
Name | Type | Required | Description |
---|---|---|---|
description | string | true | Description of the consent tree |
default_language | string | true | Default locale for the consent tree |
allowed_languages | [Language] | true | List of allowed languages to ask text for |
consents_order | [ConsentId] | true | Order of consents in the tree when visualized by user |
priority_consent_ids | [ConsentId] | true | List of priority consent IDs |
views | [ConsentTreeView] | true | Different views (group of consents) for the consent tree |
dependencies | [ConsentDependency] | false | (Optional) Dependencies between consents |
channels | [string] | true | Channels where the consent tree is applicable to be captured |
users_type | UserType | true | Type of users the consent tree applies to |
ConsentTreeView
|
|
Name | Type | Required | Description |
---|---|---|---|
view | string | true | Name of the view |
consents | [ConsentId] | true | Consents included in the view |
ConsentDependency
|
|
UpdateConsentTreeRequest
|
|
Name | Type | Required | Description |
---|---|---|---|
description | string | false | Description of the consent tree |
default_language | string | false | Default locale for the consent tree |
allowed_languages | [Language] | false | List of allowed languages to ask text for |
consents_order | [ConsentId] | false | Order of consents in the tree when visualized by user |
priority_consent_ids | [ConsentId] | false | List of priority consent IDs |
change_log | string | false | Description of the changes made in this update |
views | [ConsentTreeView] | false | Different views (group of consents) for the consent tree |
dependencies | [ConsentDependency] | false | (Optional) Dependencies between consents |
channels | [string] | false | Channels where the consent tree is applicable to be captured |
users_type | UserType | false | Type of users the consent tree applies to |
GetConsentsDefinitionsResponse
|
|
Name | Type | Required | Description |
---|---|---|---|
consents | [object] | true | none |
» id | ConsentId | true | Consent definition unique identifier (normalized to uppercase without spaces and special characters) |
» choice_type | ConsentType | true | Consent statement choice type list: * ACCEPTANCE - Text written in affirmative. May be in pending state* OPPOSITION - Text written in negative. It cannot be in pending state and must be represented with a checkbox |
» consent | [ConsentDetails] | true | none |
» subject | string | false | Email or identifier of the user who created/updated the consent (captured from ‘x-auth-subject’ header) |
» creation_date | string(date-time) | true | Date and time when the consent was created |
ErrorsResponse
|
|
Name | Type | Required | Description |
---|---|---|---|
errors | Errors | false | List of errors |
Errors
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | [Error] | false | List of errors |
Error
|
|
Name | Type | Required | Description |
---|---|---|---|
code | string | true | Error codes: * MCONS-000 - Internal server error* MCONS-001 - Bad request. Parameter is required but it’s missing* MCONS-002 - Bad request. Error during parsing* MCONS-003 - Bad request. Illegal or inappropriate argument* MCONS-004 - Bad request. Model validation* MCONS-005 - Unauthorized* MCONS-006 - Resource not found* MCONS-007 - Unauthorized* MCONS-008 - Unauthorized* MCONS-009 - Unauthorized* MCONS-010 - Conflict |
title | string | true | Error titles: * PARAMETER_ERROR - Bad request. Parameter is required but it’s missing* BODY_ERROR - Bad request. Error during parsing* ILLEGAL_ARGUMENT_ERROR - Bad request. Illegal or inappropriate argument* NOT_VALID_MODEL_ERROR - Bad request. Model validation* INVALID_HEADER_ERROR - Unauthorized* RESOURCE_NOT_FOUND - Resource not found* INVALID_AUTHN_HEADER_ERROR - Unauthorized* NOT_VALID_AUTHN_TOKEN_ERROR - Unauthorized |
ref | string | true | Url of the error details in developer portal |
details | string | true | Message and details of the error |
SecurizeRequestBody
|
|
Name | Type | Required | Description |
---|---|---|---|
customer_id | string | true | none |
actor_id | string | true | none |
SecurizeResponse
|
|
Name | Type | Required | Description |
---|---|---|---|
web_component_token | string | true | none |