API Overview Resources Schemas

Schemas

ConsentId

1

"C01"

Name	Type	Required	Description
anonymous	string	false	Consent definition unique identifier (normalized to uppercase without spaces and special characters)

ConsentType

1

"ACCEPTANCE"

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

1

0

Name	Type	Required	Description
anonymous	integer	false	Consent statement choice list: * `0` - Consent accepted * `1` - Consent choice unknown * `2` - Consent rejected

ConsentText

1

"Información comercial de servicios nuestros distintos a los contratados o de otras empresas del Grupo"

Name	Type	Required	Description
anonymous	string	false	Full text of the consent

ConsentDescription

1

"Pertenecemos a un Grupo de empresas que prestan productos o servicios de diversa naturaleza, tales como energía, telecomunicaciones, tecnológicos, servicios y equipos para el hogar, financieros o servicios de valor añadido relacionados, por ejemplo, con la salud o seguros o autoconsumo, habitualmente con descuentos o condiciones especiales para clientes del Grupo."

Name	Type	Required	Description
anonymous	string	false	Detailed description of the consent

Language

1

"es"

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

UserSegment

1

"string"

Name	Type	Required	Description
anonymous	string	false	Regulated sector where user belongs to. Allowed values: telco, energy

UserType

1

"customers, leads"

Name	Type	Required	Description
anonymous	string	false	Type of users the consent tree applies to

SellChannel

1

"ecare"

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

ConfigurationTreeDescription

1

"Default Telco Configuration"

Name	Type	Required	Description
anonymous	string	false	Description of the consent tree

EmailSubject

1

"john@company.com"

Name	Type	Required	Description
anonymous	string	false	Email or identifier of the user who created/updated the resource

DateTimeProperty

1

"2023-12-15T08:23:13.000Z"

Name	Type	Required	Description
anonymous	string(date-time)	false	Date and time in ISO format

UuidProperty

1

"d290f1ee-6c54-4b01-90e6-d701748f0851"

Name	Type	Required	Description
anonymous	string(uuid)	false	none

IpAddressProperty

1

"84.44.81.103"

Name	Type	Required	Description
anonymous	string	false	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

TraceIdProperty

1

"12C148A"

Name	Type	Required	Description
anonymous	string	false	Trazability info

ActorIdProperty

1

"YC004315"

Name	Type	Required	Description
anonymous	string	false	Information about what agent/system/user is setting consents

LocaleProperty

1

"es_ES"

Name	Type	Required	Description
anonymous	string	false	Locale. If text is not found, locale will be the organization default locale

DefaultLanguageProperty

1

"es-ES"

Name	Type	Required	Description
anonymous	string	false	Default locale for the consent tree

ChangeLogProperty

1

"Added new consent"

Name	Type	Required	Description
anonymous	string	false	Description of the changes made in this update

ChangesDescriptionProperty

1

"Added new language"

Name	Type	Required	Description
anonymous	string	false	Optional description of the changes made

AllowedLanguages

1
2
3
4
5


[
  "es",
  "eu",
  "en"
]

Name	Type	Required	Description
anonymous	[Language]	false	List of allowed languages to ask consent text for

PriorityConsentIds

1
2
3


[
  "C01"
]

Name	Type	Required	Description
anonymous	[ConsentId]	false	List of priority consent Ids

ConsentsOrder

1
2
3


[
  "C01"
]

Name	Type	Required	Description
anonymous	[ConsentId]	false	Order of consents in the tree when visualized by user

ConsentsViews

1
2
3
4
5
6
7
8


[
  {
    "view": "MANDATORY",
    "consents": [
      "C01"
    ]
  }
]

Name	Type	Required	Description
anonymous	[ConsentTreeView]	false	Different views (group of consents) for the consent tree

ConsentsDependencies

1
2
3
4
5
6
7
8


[
  {
    "father": "C01",
    "child": [
      "C01"
    ]
  }
]

Name	Type	Required	Description
anonymous	[ConsentDependency]	false	(Optional) Dependencies between consents

CaptureChannels

1
2
3
4
5
6
7


[
  "crm",
  "agents",
  "web",
  "whatsapp",
  "landing"
]

None

CreateConsentDetails

1
2
3
4
5
6


{
  "language": "es",
  "text": "Información comercial de servicios nuestros distintos a los contratados o de otras empresas del Grupo",
  "description": "Pertenecemos a un Grupo de empresas que prestan productos o servicios de diversa naturaleza, tales como energía, telecomunicaciones, tecnológicos, servicios y equipos para el hogar, financieros o servicios de valor añadido relacionados, por ejemplo, con la salud o seguros o autoconsumo, habitualmente con descuentos o condiciones especiales para clientes del Grupo.",
  "short_text": "Información de otros servicios contratados"
}

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	ConsentText	true	Full text of the consent
description	ConsentDescription	true	Detailed description of the consent
short_text	string	false	Shortened version of the consent text

ConsentDetails

1
2
3
4
5
6


{
  "language": "es",
  "text": "Información comercial de servicios nuestros distintos a los contratados o de otras empresas del Grupo",
  "description": "Pertenecemos a un Grupo de empresas que prestan productos o servicios de diversa naturaleza, tales como energía, telecomunicaciones, tecnológicos, servicios y equipos para el hogar, financieros o servicios de valor añadido relacionados, por ejemplo, con la salud o seguros o autoconsumo, habitualmente con descuentos o condiciones especiales para clientes del Grupo.",
  "short_text": "Información de otros servicios contratados"
}

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	ConsentText	true	Full text of the consent
description	ConsentDescription	true	Detailed description of the consent
short_text	string	true	Shortened version of the consent text

UserConsentSelection

1
2
3
4


{
  "id": "C01",
  "choice": 0
}

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

ConsentTreeView

1
2
3
4
5
6


{
  "view": "MANDATORY",
  "consents": [
    "C01"
  ]
}

Name	Type	Required	Description
view	string	true	Name of the view
consents	[ConsentId]	true	Consents included in the view

ConsentDependency

1
2
3
4
5
6


{
  "father": "C01",
  "child": [
    "C01"
  ]
}

Name	Type	Required	Description
father	ConsentId	true	Consent definition unique identifier (normalized to uppercase without spaces and special characters)
child	[ConsentId]	true	consent_id of the child consents dependent on the father

GetConsentsResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15


{
  "statements": [
    {
      "id": "C01",
      "choice": 0,
      "choice_type": "ACCEPTANCE",
      "text": "Información comercial de servicios nuestros distintos a los contratados o de otras empresas del Grupo",
      "description": "Pertenecemos a un Grupo de empresas que prestan productos o servicios de diversa naturaleza, tales como energía, telecomunicaciones, tecnológicos, servicios y equipos para el hogar, financieros o servicios de valor añadido relacionados, por ejemplo, con la salud o seguros o autoconsumo, habitualmente con descuentos o condiciones especiales para clientes del Grupo.",
      "child_statements": [
        {}
      ]
    }
  ],
  "locale": "es_ES"
}

Name	Type	Required	Description
statements	[GetConsentStatement]	true	Tree structure for consents and default choices where keys are identifiers
locale	LocaleProperty	true	Locale. If text is not found, locale will be the organization default locale

PostConsentsResponse

1
2
3


{
  "id": "string"
}

Name	Type	Required	Description
id	any	true	none

Name	Type	Required	Description
» anonymous	UuidProperty	false	none

Name	Type	Required	Description
» anonymous	any	false	User consents unique identifier at Mas Consents

GetConsentStatement

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17


{
  "id": "C01",
  "choice": 0,
  "choice_type": "ACCEPTANCE",
  "text": "Información comercial de servicios nuestros distintos a los contratados o de otras empresas del Grupo",
  "description": "Pertenecemos a un Grupo de empresas que prestan productos o servicios de diversa naturaleza, tales como energía, telecomunicaciones, tecnológicos, servicios y equipos para el hogar, financieros o servicios de valor añadido relacionados, por ejemplo, con la salud o seguros o autoconsumo, habitualmente con descuentos o condiciones especiales para clientes del Grupo.",
  "child_statements": [
    {
      "id": "C01",
      "choice": 0,
      "choice_type": "ACCEPTANCE",
      "text": "Información comercial de servicios nuestros distintos a los contratados o de otras empresas del Grupo",
      "description": "Pertenecemos a un Grupo de empresas que prestan productos o servicios de diversa naturaleza, tales como energía, telecomunicaciones, tecnológicos, servicios y equipos para el hogar, financieros o servicios de valor añadido relacionados, por ejemplo, con la salud o seguros o autoconsumo, habitualmente con descuentos o condiciones especiales para clientes del Grupo.",
      "child_statements": []
    }
  ]
}

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
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	ConsentText	true	Full text of the consent
description	ConsentDescription	true	Detailed description of the consent
child_statements	[GetConsentStatement]	true	Nested user consent statements

PostConsentsCustomerRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13


{
  "actor_id": "YC004315",
  "selections": [
    {
      "id": "C01",
      "choice": 0
    }
  ],
  "ip": "84.44.81.103",
  "sell_channel": "ecare",
  "trace_id": "12C148A",
  "capture_date": "2023-12-15T08:23:13.000Z"
}

Name	Type	Required	Description
actor_id	ActorIdProperty	true	Information about what agent/system/user is setting consents
selections	[UserConsentSelection]	true	User cosents choices, in array format, chosen by the user
ip	IpAddressProperty	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	TraceIdProperty	true	Trazability info
capture_date	DateTimeProperty	true	Date and time in ISO format

GetUserMetadataResponse

1
2
3
4


{
  "customer_id": "439885739840",
  "impact": true
}

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

CreateConsentRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


{
  "id": "C01",
  "type": "ACCEPTANCE",
  "consent": [
    {
      "language": "es",
      "text": "Información comercial de servicios nuestros distintos a los contratados o de otras empresas del Grupo",
      "description": "Pertenecemos a un Grupo de empresas que prestan productos o servicios de diversa naturaleza, tales como energía, telecomunicaciones, tecnológicos, servicios y equipos para el hogar, financieros o servicios de valor añadido relacionados, por ejemplo, con la salud o seguros o autoconsumo, habitualmente con descuentos o condiciones especiales para clientes del Grupo.",
      "short_text": "Información de otros servicios contratados"
    }
  ]
}

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	[CreateConsentDetails]	true	Array of consent details for different locales

SavedConsentResponse

1
2
3
4
5
6
7
8


{
  "id": "C01",
  "languages": [
    "es",
    "eu",
    "en"
  ]
}

Name	Type	Required	Description
id	ConsentId	true	Consent definition unique identifier (normalized to uppercase without spaces and special characters)
languages	AllowedLanguages	true	List of allowed languages to ask consent text for

UpdateConsentRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "consent": [
    {
      "language": "es",
      "text": "Información comercial de servicios nuestros distintos a los contratados o de otras empresas del Grupo",
      "description": "Pertenecemos a un Grupo de empresas que prestan productos o servicios de diversa naturaleza, tales como energía, telecomunicaciones, tecnológicos, servicios y equipos para el hogar, financieros o servicios de valor añadido relacionados, por ejemplo, con la salud o seguros o autoconsumo, habitualmente con descuentos o condiciones especiales para clientes del Grupo.",
      "short_text": "Información de otros servicios contratados"
    }
  ],
  "changes_description": "Added new language"
}

Name	Type	Required	Description
consent	[CreateConsentDetails]	true	none
changes_description	ChangesDescriptionProperty	false	Optional description of the changes made

CreateConsentTreeRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39


{
  "description": "Default Telco Configuration",
  "default_language": "es-ES",
  "allowed_languages": [
    "es",
    "eu",
    "en"
  ],
  "consents_order": [
    "C01"
  ],
  "priority_consent_ids": [
    "C01"
  ],
  "views": [
    {
      "view": "MANDATORY",
      "consents": [
        "C01"
      ]
    }
  ],
  "dependencies": [
    {
      "father": "C01",
      "child": [
        "C01"
      ]
    }
  ],
  "channels": [
    "crm",
    "agents",
    "web",
    "whatsapp",
    "landing"
  ],
  "users_type": "customers, leads"
}

Name	Type	Required	Description
description	ConfigurationTreeDescription	true	Description of the consent tree
default_language	DefaultLanguageProperty	true	Default locale for the consent tree
allowed_languages	AllowedLanguages	true	List of allowed languages to ask consent text for
consents_order	ConsentsOrder	true	Order of consents in the tree when visualized by user
priority_consent_ids	PriorityConsentIds	true	List of priority consent Ids
views	ConsentsViews	true	Different views (group of consents) for the consent tree
dependencies	ConsentsDependencies	false	(Optional) Dependencies between consents
channels	CaptureChannels	true	Channels where the consent tree is applicable to be captured
users_type	UserType	true	Type of users the consent tree applies to

UpdateConsentTreeRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40


{
  "description": "Default Telco Configuration",
  "default_language": "es-ES",
  "allowed_languages": [
    "es",
    "eu",
    "en"
  ],
  "consents_order": [
    "C01"
  ],
  "priority_consent_ids": [
    "C01"
  ],
  "change_log": "Added new consent",
  "views": [
    {
      "view": "MANDATORY",
      "consents": [
        "C01"
      ]
    }
  ],
  "dependencies": [
    {
      "father": "C01",
      "child": [
        "C01"
      ]
    }
  ],
  "channels": [
    "crm",
    "agents",
    "web",
    "whatsapp",
    "landing"
  ],
  "users_type": "customers, leads"
}

Name	Type	Required	Description
description	ConfigurationTreeDescription	false	Description of the consent tree
default_language	DefaultLanguageProperty	false	Default locale for the consent tree
allowed_languages	AllowedLanguages	false	List of allowed languages to ask consent text for
consents_order	ConsentsOrder	false	Order of consents in the tree when visualized by user
priority_consent_ids	PriorityConsentIds	false	List of priority consent Ids
change_log	ChangeLogProperty	false	Description of the changes made in this update
views	ConsentsViews	false	Different views (group of consents) for the consent tree
dependencies	ConsentsDependencies	false	(Optional) Dependencies between consents
channels	CaptureChannels	false	Channels where the consent tree is applicable to be captured
users_type	UserType	false	Type of users the consent tree applies to

GetConsentsDefinitionsResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18


{
  "consents": [
    {
      "id": "C01",
      "choice_type": "ACCEPTANCE",
      "consent": [
        {
          "language": "es",
          "text": "Información comercial de servicios nuestros distintos a los contratados o de otras empresas del Grupo",
          "description": "Pertenecemos a un Grupo de empresas que prestan productos o servicios de diversa naturaleza, tales como energía, telecomunicaciones, tecnológicos, servicios y equipos para el hogar, financieros o servicios de valor añadido relacionados, por ejemplo, con la salud o seguros o autoconsumo, habitualmente con descuentos o condiciones especiales para clientes del Grupo.",
          "short_text": "Información de otros servicios contratados"
        }
      ],
      "subject": "john@company.com",
      "creation_date": "string"
    }
  ]
}

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	EmailSubject	false	Email or identifier of the user who created/updated the resource
» creation_date	any	true	none

Name	Type	Required	Description
»» anonymous	DateTimeProperty	false	Date and time in ISO format

Name	Type	Required	Description
»» anonymous	any	false	Date and time when the consent was created

GetConsentTreesResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46


{
  "trees": [
    {
      "segment": "string",
      "users_type": "customers, leads",
      "description": "Default Telco Configuration",
      "default_locale": "es",
      "allowed_locales": [
        "es",
        "eu",
        "en"
      ],
      "consents_order": [
        "C01"
      ],
      "priority_consent_ids": [
        "C01"
      ],
      "views": [
        {
          "view": "MANDATORY",
          "consents": [
            "C01"
          ]
        }
      ],
      "dependencies": [
        {
          "father": "C01",
          "child": [
            "C01"
          ]
        }
      ],
      "channels": [
        "crm",
        "agents",
        "web",
        "whatsapp",
        "landing"
      ],
      "creation_subject": "string",
      "creation_date": "string"
    }
  ]
}

Name	Type	Required	Description
trees	[ConfigurationTree]	true	List of consent trees configurations

ConfigurationTree

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42


{
  "segment": "string",
  "users_type": "customers, leads",
  "description": "Default Telco Configuration",
  "default_locale": "es",
  "allowed_locales": [
    "es",
    "eu",
    "en"
  ],
  "consents_order": [
    "C01"
  ],
  "priority_consent_ids": [
    "C01"
  ],
  "views": [
    {
      "view": "MANDATORY",
      "consents": [
        "C01"
      ]
    }
  ],
  "dependencies": [
    {
      "father": "C01",
      "child": [
        "C01"
      ]
    }
  ],
  "channels": [
    "crm",
    "agents",
    "web",
    "whatsapp",
    "landing"
  ],
  "creation_subject": "string",
  "creation_date": "string"
}

Name	Type	Required	Description
segment	UserSegment	true	Regulated sector where user belongs to. Allowed values: telco, energy
users_type	UserType	true	Type of users the consent tree applies to
description	ConfigurationTreeDescription	false	Description of the consent tree
default_locale	string	true	Default language for the consent tree
allowed_locales	AllowedLanguages	true	List of allowed languages to ask consent text for
consents_order	ConsentsOrder	true	Order of consents in the tree when visualized by user
priority_consent_ids	PriorityConsentIds	false	List of priority consent Ids
views	ConsentsViews	true	Different views (group of consents) for the consent tree
dependencies	ConsentsDependencies	false	(Optional) Dependencies between consents
channels	CaptureChannels	true	Channels where the consent tree is applicable to be captured
creation_subject	any	true	none

Name	Type	Required	Description
» anonymous	EmailSubject	false	Email or identifier of the user who created/updated the resource

Name	Type	Required	Description
» anonymous	any	false	Email or identifier of the user who created the consent tree

Name	Type	Required	Description
creation_date	any	true	none

Name	Type	Required	Description
» anonymous	DateTimeProperty	false	Date and time in ISO format

Name	Type	Required	Description
» anonymous	any	false	Date and time when the consent tree was created

ErrorsResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "errors": [
    {
      "code": "MCONS_CODE",
      "title": "ERROR_TITLE",
      "ref": "https://developers.masstack.com/en/docs/apis_consents_doc_swagger/2/schemas/#schemaerror",
      "details": "Details of the error"
    }
  ]
}

Name	Type	Required	Description
errors	Errors	false	List of errors

Errors

1
2
3
4
5
6
7
8


[
  {
    "code": "MCONS_CODE",
    "title": "ERROR_TITLE",
    "ref": "https://developers.masstack.com/en/docs/apis_consents_doc_swagger/2/schemas/#schemaerror",
    "details": "Details of the error"
  }
]

Name	Type	Required	Description
anonymous	[Error]	false	List of errors

Error

1
2
3
4
5
6


{
  "code": "MCONS_CODE",
  "title": "ERROR_TITLE",
  "ref": "https://developers.masstack.com/en/docs/apis_consents_doc_swagger/2/schemas/#schemaerror",
  "details": "Details of the 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

1
2
3
4


{
  "customer_id": "string",
  "actor_id": "string"
}

Name	Type	Required	Description
customer_id	string	true	none
actor_id	string	true	none

SecurizeResponse

1
2
3


{
  "web_component_token": "string"
}

Name	Type	Required	Description
web_component_token	string	true	none