Users

Get customer tree associated to a given document identification, email or number

Returns customer tree data

POST /orgs/{orgId}/users/tree

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	organization name
body	body	UserTreeSearch	true	User search parameters

Request body - instance of UserTreeSearch

1
2
3
4


{
  "document_type": "NIF",
  "document": "string"
}

Name	Type	Required	Description
anonymous	UserDocumentSearch	false	document type and value for user search

Name	Type	Required	Description
anonymous	UserNumberSearch	false	user number (MSISDN)

Name	Type	Required	Description
anonymous	UserEmailSearch	false	user email

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10



curl -X POST https://customers.sta.masstack.com/v2/orgs/telco/users/tree \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY" \
 --data-raw "{
  'document_type': 'NIF',
  'document': 'string'
}" 

Responses

Code	Meaning	Description	Schema
200	OK	successful operation	Users-user
400	Bad Request	Invalid request body	ErrorMessage
403	Forbidden	Forbidden resource	ErrorMessage

Get customer tree by client info

DEPRECATED

Returns customer tree data associated to a given document identification, email or number of the client

GET /orgs/{orgId}/users/tree

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	organization name
email	query	string	false	user email
number	query	string	false	user phone number (MSISDN)
nif	query	string	false	Deprecated use documentType and document (user nif)
documentType	query	DocumentTypeSearch	false	Document type id
document	query	string	false	Document with numbers and letters

Enumerated Values

Property	Values
documentType	one of [NIF, DNI, TR, PASS, CIF]

Request example

1
2
3
4
5



curl -X GET https://customers.sta.masstack.com/v2/orgs/telco/users/tree?email='john.doe@example.com'&number='12345'&documentType='NIF'&document='12345678A' \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
200	OK	successful operation	Users-user
400	Bad Request	Invalid request body	ErrorMessage
403	Forbidden	Forbidden resource	ErrorMessage

Get full customer tree associated to a given document identification

Returns full customer tree data

POST /orgs/{orgId}/users/tree/full

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	organization name
body	body	UserDocumentSearch	true	Contains product data

Request body - instance of UserDocumentSearch

1
2
3
4


{
  "document_type": "NIF",
  "document": "string"
}

Name	Type	Required	Description
document_type	DocumentTypeSearch	true	document type value
document	string	true	none

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10



curl -X POST https://customers.sta.masstack.com/v2/orgs/telco/users/tree/full \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY" \
 --data-raw "{
  'document_type': 'NIF',
  'document': 'string'
}" 

Responses

Code	Meaning	Description	Schema
200	OK	successful operation	Users-user
400	Bad Request	Invalid request body	ErrorMessage
403	Forbidden	Forbidden resource	ErrorMessage

Get customer full tree

DEPRECATED

Returns full customer tree data associated to a given document identification

GET /orgs/{orgId}/users/tree/full

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	organization name
nif	query	string	false	Deprecated use documentType and document (user nif)
documentType	query	DocumentTypeSearch	false	Document type id
document	query	string	false	Document with numbers and letters

Enumerated Values

Property	Values
documentType	one of [NIF, DNI, TR, PASS, CIF]

Request example

1
2
3
4
5



curl -X GET https://customers.sta.masstack.com/v2/orgs/telco/users/tree/full?documentType='NIF'&document='12345678A' \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
200	OK	successful operation	Users-user
400	Bad Request	Invalid request body	ErrorMessage
403	Forbidden	Forbidden resource	ErrorMessage

Get user detail

Returns user data by userId

GET /orgs/{orgId}/users/{userId}

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	organization name
userId	path	integer(int64)	true	user identifier

Request example

1
2
3
4
5



curl -X GET https://customers.sta.masstack.com/v2/orgs/telco/users/214748364 \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
200	OK	successful operation	User
400	Bad Request	Invalid request body	ErrorMessage
404	Not Found	Resource not found	ErrorMessage
405	Method Not Allowed	Method not allowed	None

200 - instance of User

Custom schema example

 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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62


{
  "id": 214748364,
  "customer_id": 214748364,
  "language": {
    "id": 90,
    "value": "Castellano"
  },
  "document_type": {
    "id": 1,
    "value": "NUMERO IDENTIFICACION FISCAL"
  },
  "document_value": "11111111A",
  "sector": {
    "id": 1,
    "value": "RESIDENCIAL"
  },
  "type": {
    "id": 1,
    "value": "PARTICULAR"
  },
  "nationality": {
    "id": 214748364,
    "value": "ESPAÑA"
  },
  "personal": {
    "first_name": "John",
    "middle_name": "Nicholas",
    "last_name": "Doe",
    "gender": "M",
    "birthdate": "2019-08-24",
    "other_phone": 12345,
    "email": "john.doe@example.com"
  },
  "business": {
    "company": "SPACEX",
    "created_date": "2019-08-24",
    "other_phone": 12345,
    "email": "john.doe@example.com",
    "responsable": {
      "id": 214748364,
      "name": "John",
      "middlename": "Nicholas",
      "lastname": "Doe",
      "document_type_id": 1,
      "document_value": "11111111A",
      "nationality_id": 214748364,
      "nationality_iso": "ES",
      "nationality_value": "España"
    }
  },
  "address_info": {
    "state_id": 214748364,
    "address": "CALLE EMILIO FERRARI",
    "state": "MADRID",
    "zip_code": "28017",
    "locality": "MADRID"
  },
  "special_treatment": {
    "id": 214748364,
    "value": "Influencer"
  }
}

Name	Type	Required	Description
id	integer(int64)	true	none
customer_id	integer(int64)	false	none
language	LanguageType	false	none
document_type	DocumentType	true	none
document_value	string	true	none
sector	UserSector	false	none
type	UserType	true	none
nationality	Nationality	false	none
personal	Personal	false	none
business	Business	false	none
address_info	UserAddress	false	none
special_treatment	SpecialTreatment	false	possible values can be retrieved in /signups/master-data service

Agile TV change email subscription

Patch users agile tv subscription

PATCH /orgs/{orgId}/users/agile-tv

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	organization name
body	body	PatchAgileTvSubscriptionRequest	true	‘none’

Request body - JsonObject

1
2
3
4
5


{
  "old_email": "old_email@example.com",
  "new_email": "new_email@example.com",
  "document_number": "11111111A"
}

Name	Type	Required	Description
old_email	string	true	none
new_email	string	true	none
document_number	string	true	none

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11



curl -X PATCH https://customers.sta.masstack.com/v2/orgs/telco/users/agile-tv \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY" \
 --data-raw "{
  'old_email': 'old_email@example.com',
  'new_email': 'new_email@example.com',
  'document_number': '11111111A'
}" 

Responses

Code	Meaning	Description	Schema
200	OK	successful operation	None
400	Bad Request	Invalid request body	ErrorMessage
404	Not Found	Resource not found	ErrorMessage