API Overview Resources Schemas

Schemas

_search_params

1
2
3
4
5
6
7


{
  "way_name": "San Juan",
  "number": "1",
  "way_type": "Paseo",
  "town": "Pedro Andres",
  "postal_code": "02534"
}

Name	Type	Required	Description
way_name	string	true	Way name
number	string	true	Number
way_type	string	false	Way type
town	string	false	Town name
postal_code	string	false	Postal Code

_building

 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


{
  "id": "01000500474700067",
  "technical_id": "01000500474700067",
  "address": {
    "summary": "AVENIDA IRUÃ‘A-VELEIA, 67, 01015 VITORIA-GASTEIZ",
    "description": "",
    "street_type": "AVENIDA",
    "street_name": "IRUÃ‘A-VELEIA",
    "number": "67",
    "town": "VITORIA-GASTEIZ",
    "postal_code": "01015",
    "province": "ALAVA",
    "province_id": "1"
  },
  "coverage": [
    {
      "territory_owner": "FIBNEB01",
      "operator": "TELEFONICA_NEBA",
      "pai_local": "0110096001",
      "terminal_exchange": "0110096",
      "pai": "1",
      "territory_owner_type": "DIRECT_COVERAGE",
      "technology": "FTTH",
      "availability": false,
      "availability_info": {
        "reason": "razon",
        "completion_date": "2025-01-01"
      },
      "priority": "1",
      "speeds": {
        "estimated": "100M_100M || 50M_50M",
        "profile": "100M_100M || 50M_50M"
      }
    }
  ],
  "geo_code": {},
  "units": [
    {
      "id": "01000500474700067         002C       ",
      "technical_id": "01000500474700067         002C       ",
      "territory_owners": [
        "FIBMM01"
      ],
      "territory_owner_type": "DIRECT_COVERAGE",
      "blocked_territory_owners": [
        "FIBMM01"
      ],
      "address_description": {
        "bis_duplicate": " ",
        "block": "   ",
        "door": "  ",
        "letter": " ",
        "stair": "  ",
        "floor": "004",
        "hand1": "MOD ",
        "hand2": "6   ",
        "summary": " "
      }
    }
  ]
}

Name	Type	Required	Description
id	string	false	none
technical_id	string	false	none
address	object	false	none
» summary	string	false	none
» description	string	false	none
» street_type	string	false	none
» street_name	string	false	none
» number	string	false	none
» town	string	false	none
» postal_code	string	false	none
» province	string	false	none
» province_id	string	false	none
coverage	[_coverage]	false	none
geo_code	object	false	none
units	[_unit_summary]	false	none

_availabilities_response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23


[
  {
    "availability": true,
    "reason": {
      "id": "coverage-load-2023-10-30",
      "user": "example@email.com",
      "status": "DONE",
      "load_type": "FTTH_COVERAGE",
      "files": [
        "GIT_107_107_01_231031_01_00073616.csv"
      ],
      "stages": [
        {
          "stage": "PRELOAD",
          "status": "DONE",
          "log": "string",
          "started_at": "2023-10-30 17:15:56",
          "ended_at": "2023-10-30 17:36:22"
        }
      ]
    }
  }
]

Name	Type	Required	Description
anonymous	[_availability_response_entry]	false	none

_availability_response_entry

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


{
  "availability": true,
  "reason": {
    "id": "coverage-load-2023-10-30",
    "user": "example@email.com",
    "status": "DONE",
    "load_type": "FTTH_COVERAGE",
    "files": [
      "GIT_107_107_01_231031_01_00073616.csv"
    ],
    "stages": [
      {
        "stage": "PRELOAD",
        "status": "DONE",
        "log": "string",
        "started_at": "2023-10-30 17:15:56",
        "ended_at": "2023-10-30 17:36:22"
      }
    ]
  }
}

Name	Type	Required	Description
availability	boolean	false	none
reason	load_info_response	false	none

_coverage

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


{
  "territory_owner": "FIBNEB01",
  "operator": "TELEFONICA_NEBA",
  "pai_local": "0110096001",
  "terminal_exchange": "0110096",
  "pai": "1",
  "territory_owner_type": "DIRECT_COVERAGE",
  "technology": "FTTH",
  "availability": false,
  "availability_info": {
    "reason": "razon",
    "completion_date": "2025-01-01"
  },
  "priority": "1",
  "speeds": {
    "estimated": "100M_100M || 50M_50M",
    "profile": "100M_100M || 50M_50M"
  }
}

Name	Type	Required	Description
territory_owner	string	false	none
operator	string	false	none
pai_local	string	false	none
terminal_exchange	string	false	none
pai	string	false	none
territory_owner_type	territory_owner_type	false	Enum representing both type TO
technology	string	false	none
availability	boolean	false	false indicates that the footprint is blocked
availability_info	object	false	only shows when availability is false
» reason	string	false	none
» completion_date	string	false	none
priority	string	false	the lower the most priority
speeds	object	false	none
» estimated	string	false	none
» profile	string	false	none

Property	Values
technology	one of [ADSL, FTTH, HFC]

_unit_coverage

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


{
  "territory_owner": "FIBMM01",
  "operator": "MASMOVIL",
  "territory_owner_type": "DIRECT_COVERAGE",
  "availability_info": {
    "reason": "razon",
    "completion_date": "2025-01-01"
  },
  "address_id": "M0000000000000000000000000000005512611",
  "pai_local": "0110096001",
  "terminal_exchange": "0110096",
  "pai": "1",
  "technology": "FTTH",
  "availability": false,
  "priority": "1",
  "speeds": {
    "estimated": "100M_100M || 50M_50M",
    "profile": "100M_100M || 50M_50M"
  }
}

Name	Type	Required	Description
territory_owner	string	false	none
operator	string	false	none
territory_owner_type	territory_owner_type	false	Enum representing both type TO
availability_info	object	false	only shows when availability is false
» reason	string	false	none
» completion_date	string	false	none
address_id	string	false	none
pai_local	string	false	none
terminal_exchange	string	false	none
pai	string	false	none
technology	string	false	none
availability	boolean	false	false indicates that the footprint is blocked
priority	string	false	none
speeds	object	false	none
» estimated	string	false	none
» profile	string	false	none

Property	Values
technology	one of [ADSL, FTTH, HFC]

_unit

 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


{
  "id": "28000010130200007       W 001E       ",
  "technical_id": "28000010130200007       W 001E       ",
  "address_description": {
    "bis_duplicate": "",
    "block": "",
    "door": "",
    "letter": "",
    "stair": "Derecha",
    "floor": "001",
    "hand1": "E",
    "hand2": "",
    "summary": "DERECHA 001E"
  },
  "parent": {
    "id": "28000010130200007",
    "coverage": [
      {
        "territory_owner": "FIBNEB01",
        "operator": "TELEFONICA_NEBA",
        "pai_local": "0110096001",
        "terminal_exchange": "0110096",
        "pai": "1",
        "territory_owner_type": "DIRECT_COVERAGE",
        "technology": "FTTH",
        "availability": false,
        "availability_info": {
          "reason": "razon",
          "completion_date": "2025-01-01"
        },
        "priority": "1",
        "speeds": {
          "estimated": "100M_100M || 50M_50M",
          "profile": "100M_100M || 50M_50M"
        }
      }
    ]
  },
  "coverage": [
    {
      "territory_owner": "FIBMM01",
      "operator": "MASMOVIL",
      "territory_owner_type": "DIRECT_COVERAGE",
      "availability_info": {
        "reason": "razon",
        "completion_date": "2025-01-01"
      },
      "address_id": "M0000000000000000000000000000005512611",
      "pai_local": "0110096001",
      "terminal_exchange": "0110096",
      "pai": "1",
      "technology": "FTTH",
      "availability": false,
      "priority": "1",
      "speeds": {
        "estimated": "100M_100M || 50M_50M",
        "profile": "100M_100M || 50M_50M"
      }
    }
  ]
}

Name	Type	Required	Description
id	string	false	none
technical_id	string	false	none
address_description	object	false	none
» bis_duplicate	string	false	dato de la finca
» block	string	false	dato de la finca
» door	string	false	dato de la finca
» letter	string	false	dato de la finca
» stair	string	false	dato de la escalera
» floor	string	false	dato del domicilio
» hand1	string	false	dato del domicilio
» hand2	string	false	dato del domicilio
» summary	string	false	none
parent	object	false	none
» id	string	false	none
» coverage	[_coverage]	false	none
coverage	[_unit_coverage]	false	none

_building_summaries

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


[
  {
    "id": "28000010130200007H1",
    "technical_id": "28000010130200007",
    "score": "847.3662",
    "address": {
      "summary": "AVENIDA IRUÑA VELEIA, S/N, 01015 VITORIA-GASTEIZ",
      "description": "HOTEL",
      "street_type": "AVENIDA",
      "street_name": "IRUÑA-VELEIA",
      "number": "S/N",
      "town": "VITORIA-GASTEIZ",
      "postal_code": "01015",
      "province": "ALAVA",
      "province_id": "1"
    }
  }
]

Name	Type	Required	Description
anonymous	[_building_summary]	false	none

_building_summary

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


{
  "id": "28000010130200007H1",
  "technical_id": "28000010130200007",
  "score": "847.3662",
  "address": {
    "summary": "AVENIDA IRUÑA VELEIA, S/N, 01015 VITORIA-GASTEIZ",
    "description": "HOTEL",
    "street_type": "AVENIDA",
    "street_name": "IRUÑA-VELEIA",
    "number": "S/N",
    "town": "VITORIA-GASTEIZ",
    "postal_code": "01015",
    "province": "ALAVA",
    "province_id": "1"
  }
}

Name	Type	Required	Description
id	string	false	Not gescal. If it ends by ‘H’ is an historical street
technical_id	string	false	gescal17
score	string	false	none
address	object	false	none
» summary	string	false	street_type + street_name + number + postal_code + town + province
» description	string	false	clarifier. It shows whern number is S/N
» street_type	string	false	none
» street_name	string	false	none
» number	string	false	none
» town	string	false	none
» postal_code	string	false	none
» province	string	false	none
» province_id	string	false	none

_street_summaries

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


[
  {
    "id": "420003300195",
    "technical_id": "420003300195",
    "score": "353.05377",
    "address": {
      "summary": "Avenida IruÃ±a-Veleia Hiribidea, Vitoria-Gasteiz, ALAVA",
      "street_type": "AVENIDA",
      "street_name": "IRUÃ‘A-VELEIA",
      "town": "VITORIA-GASTEIZ",
      "province": "ALAVA",
      "province_id": "1",
      "postal_code": [
        "21877",
        "21888"
      ]
    }
  }
]

Name	Type	Required	Description
anonymous	[_street_summary]	false	none

_street_summary

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


{
  "id": "420003300195",
  "technical_id": "420003300195",
  "score": "353.05377",
  "address": {
    "summary": "Avenida IruÃ±a-Veleia Hiribidea, Vitoria-Gasteiz, ALAVA",
    "street_type": "AVENIDA",
    "street_name": "IRUÃ‘A-VELEIA",
    "town": "VITORIA-GASTEIZ",
    "province": "ALAVA",
    "province_id": "1",
    "postal_code": [
      "21877",
      "21888"
    ]
  }
}

Name	Type	Required	Description
id	string	false	gescal12
technical_id	string	false	gescal12
score	string	false	none
address	object	false	none
» summary	string	false	none
» street_type	string	false	none
» street_name	string	false	none
» town	string	false	none
» province	string	false	none
» province_id	string	false	none
» postal_code	[string]	false	none

_unit_summary

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


{
  "id": "01000500474700067         002C       ",
  "technical_id": "01000500474700067         002C       ",
  "territory_owners": [
    "FIBMM01"
  ],
  "territory_owner_type": "DIRECT_COVERAGE",
  "blocked_territory_owners": [
    "FIBMM01"
  ],
  "address_description": {
    "bis_duplicate": " ",
    "block": "   ",
    "door": "  ",
    "letter": " ",
    "stair": "  ",
    "floor": "004",
    "hand1": "MOD ",
    "hand2": "6   ",
    "summary": " "
  }
}

Name	Type	Required	Description
id	string	true	none
technical_id	string	true	none
territory_owners	[string]	false	TOs for the unit
territory_owner_type	territory_owner_type	false	Enum representing both type TO
blocked_territory_owners	[string]	false	Blocked TOs for the unit
address_description	object	true	none
» bis_duplicate	string	false	dato de la finca
» block	string	false	none
» door	string	false	none
» letter	string	false	none
» stair	string	false	none
» floor	string	false	none
» hand1	string	false	none
» hand2	string	false	none
» summary	string	false	none

_building_extra_data

1
2
3
4
5
6
7
8
9


{
  "id": "01000500474700067",
  "terminal_exchange": "##########",
  "territory_owner": "BSTOR01",
  "operator": "ORANGE",
  "pai": "1",
  "pai_local": "O0110096",
  "territory_owner_type": "DIRECT_COVERAGE"
}

Name	Type	Required	Description
id	string	false	none
terminal_exchange	string	false	none
territory_owner	string	false	none
operator	string	false	none
pai	string	false	none
pai_local	string	false	none
territory_owner_type	territory_owner_type	false	Enum representing both type TO

_unit_extra_data

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "id": "01000500474700067         003A       ",
  "address_id": "OS000000000000000000000000000000407819",
  "terminal_exchange": "##########",
  "territory_owner": "BSTOR01",
  "operator": "ORANGE",
  "pai": "01",
  "pai_local": "O0110096",
  "territory_owner_type": "DIRECT_COVERAGE"
}

Name	Type	Required	Description
id	string	false	none
address_id	string	false	none
terminal_exchange	string	false	none
territory_owner	string	false	none
operator	string	false	none
pai	string	false	none
pai_local	string	false	none
territory_owner_type	territory_owner_type	false	Enum representing both type TO

_address_code_data

1
2
3
4
5
6
7


{
  "id": "010000300045",
  "province_code": "01",
  "street_code": 1000088,
  "town_code": "100025",
  "vendor": "EXPERIAN"
}

Name	Type	Required	Description
id	string	false	none
province_code	string	false	none
street_code	string	false	none
town_code	string	false	none
vendor	string	false	none

not_found_response

1
2
3
4
5
6


{
  "code": "0001",
  "status": "NOT_FOUND",
  "message": "Resource Not Found",
  "detailMsg": "{Entity} not found for id: {id}"
}

Name	Type	Required	Description
code	string	false	none
status	string	false	none
message	string	false	none
detailMsg	string	false	none

unauthorized_response

1
2
3
4
5
6


{
  "code": "0003",
  "status": "UNAUTHORIZED",
  "message": "Unauthorized",
  "detailMsg": "Unauthorized exception"
}

Name	Type	Required	Description
code	string	false	none
status	string	false	none
message	string	false	none
detailMsg	string	false	none

bad_request_response

1
2
3
4
5
6


{
  "code": "0015",
  "status": "BAD_REQUEST",
  "message": "Bad Request",
  "detailMsg": "The field '{fieldName}' is required"
}

Name	Type	Required	Description
code	string	false	none
status	string	false	none
message	string	false	none
detailMsg	string	false	none

_clarifiers_response

1
2
3
4
5
6
7
8


[
  {
    "number": 99532,
    "description": "BRAMMER IBERIA",
    "building_id": 48005450369299540,
    "street_id": 480054503692
  }
]

Name	Type	Required	Description
anonymous	[_clarifier]	false	none

_clarifier

1
2
3
4
5
6


{
  "number": 99532,
  "description": "BRAMMER IBERIA",
  "building_id": 48005450369299540,
  "street_id": 480054503692
}

Name	Type	Required	Description
number	string	false	none
description	string	false	none
building_id	string	false	none
street_id	string	false	none

error_response

1
2
3
4
5
6


{
  "code": "0002",
  "status": "UNEXPECTED",
  "message": "Unexpected error",
  "detailMsg": "Unhandled exception"
}

Name	Type	Required	Description
code	string	false	none
status	string	false	none
message	string	false	none
detailMsg	string	false	none

bad_gateway_error_response

1
2
3
4
5
6


{
  "code": "0016",
  "status": "BAD_GATEWAY",
  "message": "Bad gateway",
  "detailMsg": "Bad gateway"
}

Name	Type	Required	Description
code	string	false	none
status	string	false	none
message	string	false	none
detailMsg	string	false	none

load_info_response

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


{
  "id": "coverage-load-2023-10-30",
  "user": "example@email.com",
  "status": "DONE",
  "load_type": "FTTH_COVERAGE",
  "files": [
    "GIT_107_107_01_231031_01_00073616.csv"
  ],
  "stages": [
    {
      "stage": "PRELOAD",
      "status": "DONE",
      "log": "string",
      "started_at": "2023-10-30 17:15:56",
      "ended_at": "2023-10-30 17:36:22"
    }
  ]
}

Name	Type	Required	Description
id	string	false	none
user	string	false	none
status	string	false	none
load_type	load_type	false	none
files	[string]	false	none
stages	[load_stage_info]	false	none

Property	Values
status	one of [RUNNING, CANCELED, FAILED, DONE]

load_summary

1
2
3
4
5
6
7


{
  "id": "coverage-load-2023-10-30",
  "user": "example@email.com",
  "type": "FTTH_COVERAGE",
  "status": "DONE",
  "started_at": "2023-10-30"
}

Name	Type	Required	Description
id	string	false	none
user	string	false	none
type	load_type	false	none
status	string	false	none
started_at	string(date)	false	none

Property	Values
status	one of [PENDING, RUNNING, DONE, CANCELED, FAILED]

load_stage_info

1
2
3
4
5
6
7


{
  "stage": "PRELOAD",
  "status": "DONE",
  "log": "string",
  "started_at": "2023-10-30 17:15:56",
  "ended_at": "2023-10-30 17:36:22"
}

Name	Type	Required	Description
stage	string	false	none
status	string	true	none
log	string	false	none
started_at	string(date-time)	true	none
ended_at	string(date-time)	true	none

Property	Values
stage	one of [PRELOAD, AUDIT_CHECK, APPLYING, DW_SYNC]
status	one of [PENDING, RUNNING, DONE, CANCELED, FAILED]

load_type

1

"FTTH_COVERAGE"

Name	Type	Required	Description
anonymous	string	false	none

Property	Values
anonymous	one of [FTTH_COVERAGE, FTTH_COVERAGE_DELTA, BLACKLIST, MAP, HISTORICAL_NAMES, null]

address_id_response

1
2
3
4
5
6
7
8
9


{
  "address_id": "MKHFC000000000000000000000000000428057",
  "territory_owners": [
    {
      "territory_owner": "FIBOR01",
      "priority": 3
    }
  ]
}

Name	Type	Required	Description
address_id	string	false	none
territory_owners	[territory_owners]	false	none

blacklist_reason

1
2
3
4
5
6


{
  "reason": "string",
  "reason_type": "string",
  "reason_code": "string",
  "duration_days": 0
}

Name	Type	Required	Description
reason	string	false	none
reason_type	string	false	none
reason_code	string	false	none
duration_days	integer(int32)	false	none

blacklist_block

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


{
  "id": 8002231318100184,
  "territory_owners": [
    "ALL",
    "EKNBLC1",
    "EKNEB01",
    "FIBNBLC1",
    "FIBNEB05",
    "MASMOVIL"
  ],
  "gescal_scope": "G17",
  "block_reason": "CANALIZADO EXTERIOR OBSTRUIDO",
  "block_reason_code": "INF_5",
  "block_until": "2023-10-30",
  "block_user": "example@masmovil.com",
  "block_role": "feasibility-blacklist-admin",
  "block_date": "2023-05-03",
  "block_observation": "example observation"
}

Name	Type	Required	Description
id	string	false	none
territory_owners	[string]	false	none
gescal_scope	string	false	none
block_reason	string	false	none
block_reason_code	string	false	none
block_until	string	false	none
block_user	string	false	none
block_role	string	false	none
block_date	string	false	none
block_observation	string	false	none

blacklist_post_block

1
2
3
4
5
6


{
  "id": 8002231318100184,
  "reason_code": "INF_5",
  "territory_owner": "ALL",
  "observation": "example observation"
}

Name	Type	Required	Description
id	string	false	none
reason_code	string	false	none
territory_owner	string	false	none
observation	string	false	none

blacklist_gescal_result

1
2
3
4
5
6
7


{
  "id": 8002231318100184,
  "territory_owner": "ALL",
  "gescal_scope": "G17",
  "block_until": "2023-11-01T00:00",
  "creation_user": "example@masmovil.com"
}

Name	Type	Required	Description
id	string	false	none
territory_owner	string	false	none
gescal_scope	string	false	none
block_until	string	false	none
creation_user	string	false	none

blacklist_unblock_valid_fields

1
2
3
4
5


{
  "is_blocked": "MDgwMDIyMzEzMTgxMDAxODQgICAgICAgICBCQSAgICAgICAgIA==",
  "territory_owner": "ALL",
  "unblock_role": "example-example-example"
}

Name	Type	Required	Description
is_blocked	string	false	none
territory_owner	string	false	none
unblock_role	string	false	none

blacklist_block_valid_fields

1
2
3
4
5
6
7
8
9


{
  "id": "08002231318100184         BA         ",
  "territory_owner": "ALL",
  "block_until": "2023-11-01",
  "reason": "DISTANCIA EXCESIVA",
  "block_user": "example@masmovil.com",
  "block_role": "example-example-example",
  "has_coverage": "EKNEB01"
}

Name	Type	Required	Description
id	string	false	none
territory_owner	string	false	none
block_until	string	false	none
reason	string	false	none
block_user	string	false	none
block_role	string	false	none
has_coverage	string	false	none

territory_owners

1
2
3
4


{
  "territory_owner": "FIBOR01",
  "priority": 3
}

Name	Type	Required	Description
territory_owner	string	false	none
priority	string	false	none

isBlocked

1
2
3
4


{
  "contactType": "number",
  "value": 696969696
}

Name	Type	Required	Description
contactType	string	true	none
value	string	true	none

Property	Values
contactType	one of [number, email]

bad_request_finance_response

1
2
3
4
5
6


{
  "code": "0015",
  "status": "BAD_REQUEST",
  "message": "Bad Request",
  "detailMsg": "detailMsg"
}

Name	Type	Required	Description
code	string	false	none
status	string	false	none
message	string	false	none
detailMsg	string	false	none

accepted

1
2
3


{
  "isBlocked": true
}

Name	Type	Required	Description
isBlocked	boolean	false	none

finance_required_info

 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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90


{
  "personal_details": {
    "personal_data": {
      "document_id": {
        "type": "NIF",
        "value": "11111111A",
        "expiration_date": "YYYY-MM-DD"
      },
      "name": "Lorenzo",
      "surnames": [
        "Muñoz",
        "Medina"
      ],
      "birthdate": "YYYY-MM-DD",
      "gender": 1,
      "nationality": "ES"
    },
    "contact_data": {
      "email": "example@example.com",
      "phone_number": "6XXXXXXXX",
      "phone_number2": "6XXXXXXXX"
    },
    "employment": {
      "profession": 8,
      "company": "Mycompany S.A.",
      "income": "1900,00 / 1900.00",
      "income_source": 1,
      "other_income_source": "Otra fuente",
      "activity_country": "ES",
      "professional_area": 1,
      "professional_use": false
    },
    "segment": "string",
    "address": {
      "street": "Ejemplo",
      "street_type": "Calle",
      "number": "2",
      "bis": "string",
      "city": "Madrid",
      "gescal": "28XXXXXXXXXXXXXXX",
      "district": "string",
      "block": "string",
      "stair": "string",
      "floor": "string",
      "letter": "string",
      "zip_code": "28001",
      "province": "Madrid",
      "state": "string",
      "country": "ES",
      "additional_details": "string"
    }
  },
  "order_details": {
    "sfid": "string",
    "fuc_code": 323841452,
    "telco_society": 1,
    "order_type": 0,
    "device": {
      "id": "string",
      "brand": "Apple",
      "model": "Iphone 13 256 Gb",
      "name": "Apple Iphone 13 256 Gb",
      "description": "string",
      "category": 1,
      "colour": "black",
      "value": "1199,00 / 1199.00"
    }
  },
  "financial_details": {
    "financial_brand": 1,
    "financial_product": 1,
    "final_payment": "100,00 / 100.00",
    "loan": {
      "value": 119,
      "commision": 0,
      "tae": 0,
      "tin": 0,
      "duration": 0,
      "monthly_fee": 0,
      "bank_account": {
        "name": "Lorenzo",
        "surnames": [
          "Muñoz",
          "Medina"
        ],
        "iban": "string"
      }
    }
  }
}

Name	Type	Required	Description
personal_details	personal_details	false	none
order_details	order_details	false	none
financial_details	financial_details	false	none

personal_details

 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


{
  "personal_data": {
    "document_id": {
      "type": "NIF",
      "value": "11111111A",
      "expiration_date": "YYYY-MM-DD"
    },
    "name": "Lorenzo",
    "surnames": [
      "Muñoz",
      "Medina"
    ],
    "birthdate": "YYYY-MM-DD",
    "gender": 1,
    "nationality": "ES"
  },
  "contact_data": {
    "email": "example@example.com",
    "phone_number": "6XXXXXXXX",
    "phone_number2": "6XXXXXXXX"
  },
  "employment": {
    "profession": 8,
    "company": "Mycompany S.A.",
    "income": "1900,00 / 1900.00",
    "income_source": 1,
    "other_income_source": "Otra fuente",
    "activity_country": "ES",
    "professional_area": 1,
    "professional_use": false
  },
  "segment": "string",
  "address": {
    "street": "Ejemplo",
    "street_type": "Calle",
    "number": "2",
    "bis": "string",
    "city": "Madrid",
    "gescal": "28XXXXXXXXXXXXXXX",
    "district": "string",
    "block": "string",
    "stair": "string",
    "floor": "string",
    "letter": "string",
    "zip_code": "28001",
    "province": "Madrid",
    "state": "string",
    "country": "ES",
    "additional_details": "string"
  }
}

Name	Type	Required	Description
personal_data	personal_data	false	none
contact_data	contact_data	false	none
employment	employment	false	none
segment	string	false	none
address	address	false	none

personal_data

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


{
  "document_id": {
    "type": "NIF",
    "value": "11111111A",
    "expiration_date": "YYYY-MM-DD"
  },
  "name": "Lorenzo",
  "surnames": [
    "Muñoz",
    "Medina"
  ],
  "birthdate": "YYYY-MM-DD",
  "gender": 1,
  "nationality": "ES"
}

Name	Type	Required	Description
document_id	document_id	false	none
name	string	false	none
surnames	[string]	false	none
birthdate	string(date)	false	none
gender	integer	false	Enum to define the human sexes is an international standard from ISO/IEC 5218 https://en.wikipedia.org/wiki/ISO/IEC_5218 * 0 - No definido * 1 - Hombre * 2 - Mujer * 9 - No aplica
nationality	string	false	Use the ISO 3166-1 alfa-2 format

Property

Values

gender

one of [0, 1, 2, 9]

nationality

one of [AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, HR, CU, CW, CY, CZ, CI, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, SH, KN, LC, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, US, UY, UZ, VU, VE, VN, VG, VI, WF, YE, ZM, ZW]

document_id

1
2
3
4
5


{
  "type": "NIF",
  "value": "11111111A",
  "expiration_date": "YYYY-MM-DD"
}

Name	Type	Required	Description
type	string	false	none
value	string	false	none
expiration_date	string(date)	false	none

Property	Values
type	one of [CIF, NIE, NIF, Passport]

address

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


{
  "street": "Ejemplo",
  "street_type": "Calle",
  "number": "2",
  "bis": "string",
  "city": "Madrid",
  "gescal": "28XXXXXXXXXXXXXXX",
  "district": "string",
  "block": "string",
  "stair": "string",
  "floor": "string",
  "letter": "string",
  "zip_code": "28001",
  "province": "Madrid",
  "state": "string",
  "country": "ES",
  "additional_details": "string"
}

Name	Type	Required	Description
street	string	false	none
street_type	string	false	none
number	string	false	none
bis	string	false	none
city	string	false	none
gescal	string	false	none
district	string	false	none
block	string	false	none
stair	string	false	none
floor	string	false	none
letter	string	false	none
zip_code	string	false	none
province	string	false	none
state	string	false	none
country	string	false	none
additional_details	string	false	none

Property

Values

country

contact_data

1
2
3
4
5


{
  "email": "example@example.com",
  "phone_number": "6XXXXXXXX",
  "phone_number2": "6XXXXXXXX"
}

Name	Type	Required	Description
email	string	false	none
phone_number	string	false	mobile phone number
phone_number2	string	false	none

employment

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "profession": 8,
  "company": "Mycompany S.A.",
  "income": "1900,00 / 1900.00",
  "income_source": 1,
  "other_income_source": "Otra fuente",
  "activity_country": "ES",
  "professional_area": 1,
  "professional_use": false
}

Name	Type	Required	Description
profession	integer	false	Profession enum. * 1 - Obrero - sector privado * 2 - Técnico, Administrativo - sector privado * 3 - Cargo intermedio - sector privado * 4 - Directivo - sector privado * 5 - Obrero, Técnico, Administrativo - sector público * 6 - Cargo intermedio, Directivo - sector público * 8 - Autónomo * 9 - Empresario * 10 - Rentista * 11 - Vigilante de seguridad * 12 - Camarero / Vendedor de la Once * 13 - Bombero, Militar, Policia, Guardia Civil * 14 - Estudiante, Universitario, Master y Doctorado * 15 - Jubilado, Pensionista * 16 - No trabaja
company	string	false	none
income	number	false	Financing customer monthly income amount
income_source	integer	false	Income Source enum. * 1 - Herencia o Donación * 2 - Rentas de propiedad inmobiliaria * 3 - Otros
other_income_source	string	false	Mandatory if income_source=3
activity_country	string	false	none
professional_area	integer	false	Professional branch enum. * 1 - Banca, Seguros, Financieras * 2 - Sanidad y Farmacia * 3 - Enseñanza, Formación * 4 - Construcción oficios y Otros * 5 - Hostelería, Restauración * 6 - Transporte de personas y Otros * 7 - Comercio on line y segunda mano, Importación y Exportación Petróleo y Materias primas * 8 - Agricultura (otros), Ganadería, Pesca * 9 - Agencias y Agentes inmobiliarios * 10 - Arte, Piedras y Metales preciosos, Juegos de azar * 11 - Comercio ambulante * 12 - Armas y energía nuclear * 13 - Manufactura del metal, Químicos y farmacéuticos, Refinería petróleo y gas * 14 - Asesoría fiscal y Abogados * 15 - Club deportivos profesionales, sus agentes e intermediarios * 16 - Minería y extracción recursos naturales (otros) * 17 - Alcohol y Tabaco (fabricación, distribución) * 18 - Casas de cambio, Emisores medios pago virtual y prepago, Micro créditos * 19 - Comercio minorista y Mayorista (otros) * 20 - Servicios otros * 21 - Manufactura y Fabricación (otros) * 22 - Transporte de dinero, Combustibles y Mercancías * 23 - Organizaciones políticas * 24 - Talleres de coches, motos y otros automóviles * 25 - Agencias viajes, Agentes de aduanas * 26 - Agricultura intensiva en mano de obra (viñedo, aceituna, fresa, caña de azúcar,…) * 27 - Casas de subasta-empeño, Organizaciones religiosas, ONGs * 28 - Comercio: Alcohol, Tabaco, Teléfonos móviles, Equipos informáticos, Joyas y Gasolineras * 29 - Construcción, Inmobiliaria, Contratistas * 30 - Discotecas, Salas de baile, Night clubs * 31 - Empresas fiduciarias, Offshore * 32 - Fabricación barcos, aviones y otros vehículos * 33 - Minería y extracción gas y petróleo, producción y distribución energía renovable * 34 - Minería y extracción uranio, metales y piedras preciosas * 35 - Servicios de lavandería, Manejo de desechos, Limpieza ambiental
professional_use	boolean	false	none

Property	Values
profession	one of [1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16]
income_source	one of [1, 2, 3]
activity_country	one of [AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, HR, CU, CW, CY, CZ, CI, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, SH, KN, LC, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, US, UY, UZ, VU, VE, VN, VG, VI, WF, YE, ZM, ZW]
professional_area	one of [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]

order_details

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


{
  "sfid": "string",
  "fuc_code": 323841452,
  "telco_society": 1,
  "order_type": 0,
  "device": {
    "id": "string",
    "brand": "Apple",
    "model": "Iphone 13 256 Gb",
    "name": "Apple Iphone 13 256 Gb",
    "description": "string",
    "category": 1,
    "colour": "black",
    "value": "1199,00 / 1199.00"
  }
}

Name	Type	Required	Description
sfid	string	false	none
fuc_code	number	false	Unique identifier of the sales channel
telco_society	integer	false	Telco society enum. * 1 - Xfera moviles SAU * 2 - Eukastel
order_type	integer	false	Order type enum. * 0 - Alta nueva * 1 - Portabilidad * 2 - Renovación * 4 - Fusión STC
device	device	false	none

Property	Values
fuc_code	one of [323841452, 332577543, 332577626]
telco_society	one of [1, 2]
order_type	one of [0, 1, 2, 4]

device

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "id": "string",
  "brand": "Apple",
  "model": "Iphone 13 256 Gb",
  "name": "Apple Iphone 13 256 Gb",
  "description": "string",
  "category": 1,
  "colour": "black",
  "value": "1199,00 / 1199.00"
}

Name	Type	Required	Description
id	string	false	none
brand	string	false	none
model	string	false	none
name	string	false	none
description	string	false	none
category	number	false	Category enum. * 1 - Tablet * 2 - Smartwatch * 3 - Smartphone * 4 - STB * 5 - PBX * 6 - Wifiextender * 7 - Router * 8 - Otros
colour	string	false	none
value	number	false	none

Property	Values
category	one of [1, 2, 3, 4, 5, 6, 7, 8]

financial_details

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


{
  "financial_brand": 1,
  "financial_product": 1,
  "final_payment": "100,00 / 100.00",
  "loan": {
    "value": 119,
    "commision": 0,
    "tae": 0,
    "tin": 0,
    "duration": 0,
    "monthly_fee": 0,
    "bank_account": {
      "name": "Lorenzo",
      "surnames": [
        "Muñoz",
        "Medina"
      ],
      "iban": "string"
    }
  }
}

Name	Type	Required	Description
financial_brand	integer	false	Telecommunications brand used by any of the companies in Masmovil holding:
financial_product	integer	false	Financial product commercialized by any of the companies in Masmovil holding
final_payment	number	false	100,00 / 100.00
loan	loan	false	none

Property	Values
financial_brand	one of [1, 2]
financial_product	one of [1, 2, 3]

loan

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


{
  "value": 119,
  "commision": 0,
  "tae": 0,
  "tin": 0,
  "duration": 0,
  "monthly_fee": 0,
  "bank_account": {
    "name": "Lorenzo",
    "surnames": [
      "Muñoz",
      "Medina"
    ],
    "iban": "string"
  }
}

Name	Type	Required	Description
value	number	false	c
commision	number	false	Fee to be charged for the financing operation.
tae	number	false	Interest rate of the financing operation, including fees and other costs.
tin	number	false	Interest rate of the financing operation.
duration	integer	false	Duration of financing operation in months
monthly_fee	number	false	Monthly amount of the financing operation to be paid by the financing customer.
bank_account	bank_account	false	none

bank_account

1
2
3
4
5
6
7
8


{
  "name": "Lorenzo",
  "surnames": [
    "Muñoz",
    "Medina"
  ],
  "iban": "string"
}

Name	Type	Required	Description
name	string	true	none
surnames	[string]	true	none
iban	string	true	none

finance_response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "feasibility_id": "ffa10f3b-8351-4665-b50b-096b7d266cab",
  "order_id": "ffa10f3b8351",
  "authorization_id": 3025045868,
  "financial_entity": "XCF",
  "status": "Accepted",
  "granted_amount": "900.00",
  "credit_line_amount": 0,
  "financial_product": 1
}

Name	Type	Required	Description
feasibility_id	string	false	feasibility order id
order_id	string	false	bank order id
authorization_id	string	false	bank authorization id
financial_entity	string	false	entity that provides the financing
status	string	false	status of the financing
granted_amount	string	false	900,00 / 900.00
credit_line_amount	number	false	none
financial_product	integer	false	final product offered by the bank * 1 - Préstamo personal * 2 - Tarjeta de crédito * 3 - Linea de crédito (sin tarjeta)

Property	Values
financial_entity	one of [XCF]
status	one of [Accepted, Rejected]
financial_product	one of [1, 2, 3]

sales_documents_document_status_request

1
2
3
4
5


{
  "orders": [
    30453849
  ]
}

Name	Type	Required	Description
orders	[string]	false	none

sales_documents_document_status_response

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


{
  "errorCode": 0,
  "data": [
    {
      "orderId": 0,
      "orderErrorCode": 0,
      "orderErrorMessage": "string",
      "status": "A",
      "documents": [
        {
          "documentID": "string",
          "documentName": "string",
          "documentStatus": "A",
          "documentMotive": "string",
          "documentMaxSize": "string"
        }
      ]
    }
  ]
}

Name	Type	Required	Description
errorCode	number	false	none
data	_sales_documents_orders_data	false	none

_sales_documents_orders_data

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


[
  {
    "orderId": 0,
    "orderErrorCode": 0,
    "orderErrorMessage": "string",
    "status": "A",
    "documents": [
      {
        "documentID": "string",
        "documentName": "string",
        "documentStatus": "A",
        "documentMotive": "string",
        "documentMaxSize": "string"
      }
    ]
  }
]

Name	Type	Required	Description
anonymous	[_sales_documents_orders_order]	false	none

_sales_documents_orders_order

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


{
  "orderId": 0,
  "orderErrorCode": 0,
  "orderErrorMessage": "string",
  "status": "A",
  "documents": [
    {
      "documentID": "string",
      "documentName": "string",
      "documentStatus": "A",
      "documentMotive": "string",
      "documentMaxSize": "string"
    }
  ]
}

Name	Type	Required	Description
orderId	number	false	none
orderErrorCode	number	false	none
orderErrorMessage	string	false	none
status	string	false	none
documents	[_sales_documents_order_document]	false	none

Property	Values
status	one of [A, B, C]

_sales_documents_order_document

1
2
3
4
5
6
7


{
  "documentID": "string",
  "documentName": "string",
  "documentStatus": "A",
  "documentMotive": "string",
  "documentMaxSize": "string"
}

Name	Type	Required	Description
documentID	string	false	none
documentName	string	false	none
documentStatus	string	false	none
documentMotive	string	false	none
documentMaxSize	string	false	none

Property	Values
documentStatus	one of [A, B, C, D]

subscription_limit_active_request

1
2
3
4
5
6


{
  "document_type": "NIF",
  "document_id": "88662844Y",
  "subscription_type": "mobile",
  "segment": "Consumer"
}

Name	Type	Required	Description
document_type	string	false	client document type.
document_id	string	false	client document number.
subscription_type	string	false	none
segment	string	false	none

Property	Values
document_type	one of [NIF, CIF, NIE, PASSPORT, TR]
subscription_type	one of [Broadband, Landline, Mobile]
segment	one of [Consumer, SelfEmployee, SME, B2B]

subscription_limit_active_response

1
2
3
4
5
6


{
  "type": "mobile",
  "limit": 10,
  "active_subscriptions": 8,
  "subscriptions_allowed": 2
}

Name	Type	Required	Description
type	string	false	request subscription type
limit	integer	false	fraud limit
active_subscriptions	integer	false	active subscription for request type and client
subscriptions_allowed	integer	false	subscriptions allowed for request type and client

portedNumber

1
2
3
4
5
6
7


{
  "number": "911234567",
  "territoryOwner": "FIBNEB01",
  "technicalId": "12345678901234567",
  "technology": "FTTH",
  "sfid": "AW001200"
}

Name	Type	Required	Description
number	string	true	Fixed number to be ported
territoryOwner	string	true	Territory owner. Not mandatory if technology is MIFIJO
technicalId	string	true	TechnicalId (corresponding with “GESCAL” ). Not mandatory if technology is MIFIJO
technology	string	true	Technology to be provided
sfid	string	true	Seller SFID

Property	Values
technology	one of [FTTH, ADSL, MIFIJO]

_getPortabilityConditions

1
2
3
4
5
6
7
8
9


{
  "internalPortability": "false",
  "isPortable": "true",
  "installationRequired": "true",
  "operator": {
    "code": "00031",
    "name": "XTRA"
  }
}

Name	Type	Required	Description
internalPortability	boolean	false	Determines whether the process is an internal portability or not
isPortable	boolean	false	Determines whether the number is portable
installationRequired	boolean	false	Determines whether a new installation is required
operator	operator	false	none

operator

1
2
3
4


{
  "code": "00031",
  "name": "XTRA"
}

Name	Type	Required	Description
code	string	false	Operator code
name	string	false	Operator name

_map_building_summaries

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24


[
  {
    "id": "01000500474700067",
    "technical_id": "01000500474700067",
    "parent_id": "010005004747",
    "score": "847.3662",
    "address": {
      "summary": "AVENIDA IRUÑA-VELEIA, 67, 01015 VITORIA-GASTEIZ",
      "description": "",
      "street_type": "AVENIDA",
      "street_name": "IRUÑA-VELEIA",
      "number": "67",
      "town": "VITORIA-GASTEIZ",
      "postal_code": "01015",
      "province": "ALAVA",
      "province_id": 1,
      "geo_location": {
        "latitude": "42.847452",
        "longitude": "-2.7096233"
      },
      "INE_code": "1"
    }
  }
]

Name	Type	Required	Description
anonymous	[_map_building_summary]	false	none

_map_building_summary

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


{
  "id": "01000500474700067",
  "technical_id": "01000500474700067",
  "parent_id": "010005004747",
  "score": "847.3662",
  "address": {
    "summary": "AVENIDA IRUÑA-VELEIA, 67, 01015 VITORIA-GASTEIZ",
    "description": "",
    "street_type": "AVENIDA",
    "street_name": "IRUÑA-VELEIA",
    "number": "67",
    "town": "VITORIA-GASTEIZ",
    "postal_code": "01015",
    "province": "ALAVA",
    "province_id": 1,
    "geo_location": {
      "latitude": "42.847452",
      "longitude": "-2.7096233"
    },
    "INE_code": "1"
  }
}

Name	Type	Required	Description
id	string	false	none
technical_id	string	false	none
parent_id	string	false	none
score	string	false	none
address	object	false	none
» summary	string	false	none
» description	string	false	none
» street_type	string	false	none
» street_name	string	false	none
» number	string	false	none
» town	string	false	none
» postal_code	string	false	none
» province	string	false	none
» province_id	integer	false	none
» geo_location	object	false	none
»» latitude	string	false	none
»» longitude	string	false	none
» INE_code	string	false	none

_map_street_summaries

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


[
  {
    "id": "420003300195",
    "technical_id": "420003300195",
    "score": "353.05377",
    "address": {
      "sumary": "Avenida Iruña-Veleia Hiribidea, Vitoria-Gasteiz, ALAVA",
      "street_type": "AVENIDA",
      "street_name": "IRUÑA-VELEIA",
      "town": "VITORIA-GASTEIZ",
      "province": "ALAVA",
      "province_id": "1",
      "postal_code": [
        "21877",
        "21888"
      ],
      "INE_code": "1"
    }
  }
]

Name	Type	Required	Description
anonymous	[_map_street_summary]	false	none

_map_street_summary

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


{
  "id": "420003300195",
  "technical_id": "420003300195",
  "score": "353.05377",
  "address": {
    "sumary": "Avenida Iruña-Veleia Hiribidea, Vitoria-Gasteiz, ALAVA",
    "street_type": "AVENIDA",
    "street_name": "IRUÑA-VELEIA",
    "town": "VITORIA-GASTEIZ",
    "province": "ALAVA",
    "province_id": "1",
    "postal_code": [
      "21877",
      "21888"
    ],
    "INE_code": "1"
  }
}

Name	Type	Required	Description
id	string	false	none
technical_id	string	false	none
score	string	false	none
address	object	false	none
» sumary	string	false	none
» street_type	string	false	none
» street_name	string	false	none
» town	string	false	none
» province	string	false	none
» province_id	string	false	none
» postal_code	[string]	false	none
» INE_code	string	false	none

_geocode

1
2
3
4


{
  "latitude": 37.4211274197085,
  "longitude": -122.0855988802915
}

Name	Type	Required	Description
latitude	number	true	none
longitude	number	true	none

_getGeocode

1
2
3
4
5
6
7


{
  "technical_id": "01000500474700067",
  "coordinates": {
    "latitude": 37.4211274197085,
    "longitude": -122.0855988802915
  }
}

Name	Type	Required	Description
technical_id	string	false	none
coordinates	_geocode	false	none

addressConnection

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


{
  "id": "22000030036000016",
  "installer": "TESA",
  "connectionType": "P",
  "portIn": false,
  "user": "theAcomitator",
  "creationDate": "2019-07-11T10:0:00+0000",
  "updateDate": "2019-07-11T10:0:00+0000",
  "releaseReason": null,
  "comment": "it was a sunny day...",
  "estimatedReleaseDate": null
}

Name	Type	Required	Description
id	string	false	none
installer	string	false	none
connectionType	string	false	* P - CTO on post * N - CTO not pre-connectorized * NV - CTO Not pre-connectorized with structured vertical * S - Special * O - Other * null - not defined
portIn	boolean	false	True if the installer changes from MM to TESA due to Inspector intervention
user	string	false	Last user to create/modify the address connection status
creationDate	string	false	none
updateDate	string	false	none
releaseReason	string	false	* A - Automatic release based on date * I - Field Inspector * O - Other * null - Not released (Installer = TESA)
comment	string	false	none
estimatedReleaseDate	string	false	Estimated release date based on type of connection and area

Property	Values
installer	one of [“TESA”, “MM”]
connectionType	one of [“P”, “N”, “NV”, “S”, “O”, null]
releaseReason	one of [“A”, “I”, “O”, null]

errorResponse

1
2
3
4
5
6


{
  "code": "0002",
  "status": "UNEXPECTED",
  "message": "Unexpected error",
  "detailMsg": "Unexpected error"
}

Name	Type	Required	Description
code	string	false	none
status	string	false	none
message	string	false	none
detailMsg	string	false	none

timeout_response

1
2
3
4
5
6


{
  "code": "0007",
  "status": "REQUEST_TIMEOUT",
  "message": "Request Timeout",
  "detailMsg": "Name Api"
}

Name	Type	Required	Description
code	string	false	none
status	string	false	none
message	string	false	none
detailMsg	string	false	none

connectionTypes

1
2
3
4
5
6


[
  {
    "key": "string",
    "value": "string"
  }
]

Name	Type	Required	Description
anonymous	[connectionType]	false	none

connectionType

1
2
3
4


{
  "key": "string",
  "value": "string"
}

Name	Type	Required	Description
key	string	false	none
value	string	false	none

_getVolumes

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "technicalId": "01000500474700067",
  "scope": "street",
  "totalVolume": 50,
  "operators": [
    {
      "operator": "MasMovil",
      "volume": 20
    }
  ]
}

Name	Type	Required	Description
technicalId	string	false	none
scope	string	false	none
totalVolume	integer	false	none
operators	_tos	false	none

Property	Values
scope	one of [building, street, street odd, street even, town]

_tos

1
2
3
4
5
6


[
  {
    "operator": "MasMovil",
    "volume": 20
  }
]

Name	Type	Required	Description
operator	string	false	none
volume	integer	false	none

_installationsUpdate

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "operators": [
    "MasMovil"
  ],
  "installationType": "POSTE",
  "scope": "street",
  "source": {
    "user": "1231FSM",
    "type": "INSPECTOR"
  }
}

Name	Type	Required	Description
operators	array	true	none
installationType	string	true	none
scope	string	true	none
source	_source	true	none

Property	Values
installationType	one of [POSTE, POSTE H, NO POSTE]
scope	one of [building, street, street odd, street even]

_source

1
2
3
4


{
  "user": "1231FSM",
  "type": "INSPECTOR"
}

Name	Type	Required	Description
user	string	true	none
type	string	true	none

Property	Values
type	one of [INSPECTOR, CONTRATA, CIERRE, MENSAJERIA]

_getInstallationList

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


{
  "total": 50,
  "installations": [
    {
      "operators": [
        "Grupo MasMovil"
      ],
      "technicalId": "01000500474700067",
      "streetNum": "67"
    }
  ]
}

Name	Type	Required	Description
total	integer	false	none
installations	[object]	false	none
» operators	[string]	false	none
» technicalId	string	false	none
» streetNum	integer	false	none

_getInstallationType

1
2
3
4
5


{
  "installationType": [
    "POSTE"
  ]
}

Name	Type	Required	Description
installationType	[string]	false	none

_listUpdate

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


{
  "installationType": "POSTE, NO POSTE, POSTE H",
  "operators": [
    "MasMovil"
  ],
  "technicalIds": [
    "01000500474700067"
  ],
  "source": {
    "user": "1231FSM",
    "type": "INSPECTOR"
  }
}

Name	Type	Required	Description
installationType	string	false	none
operators	[string]	false	none
technicalIds	[string]	false	none
source	_source	false	none

_singleUpdate

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "cto": {
    "ctoCode": "08346863x4433xe",
    "territoryOwner": "ADAMO01",
    "installationType": "FACHADA"
  },
  "source": {
    "user": "1231FSM",
    "type": "INSPECTOR"
  }
}

Name	Type	Required	Description
cto	_ctoSingleUpdate	false	none
source	_source	false	none

_ctoSingleUpdate

1
2
3
4
5


{
  "ctoCode": "08346863x4433xe",
  "territoryOwner": "ADAMO01",
  "installationType": "FACHADA"
}

Name	Type	Required	Description
ctoCode	string	true	none
territoryOwner	string	true	none
installationType	string	true	none

conflict_response

1
2
3
4
5
6


{
  "code": "0014",
  "status": "CONFLICT",
  "message": "Conflict",
  "detailMsg": "You cannot modify the record with that type of user"
}

Name	Type	Required	Description
code	string	false	none
status	string	false	none
message	string	false	none
detailMsg	string	false	none

poleinfo_accepted

1

{}

Name	Type	Required	Description
anonymous	string	false	none

finance_availability_credit_limit_request

1
2
3
4
5
6
7


{
  "customer_id": "963085b0-f526-4a53-88bc-4d14d8311eaa",
  "account_id": "963085b0-f526-4a53-88bc-4d14d8311eaa",
  "operation": "CONVERGENT",
  "sales_app": 4,
  "dealer_id": "54321"
}

Name	Type	Required	Description
customer_id	string	false	new uuid format used by MasCustomers
account_id	string	false	new uuid format used by MasCustomers
operation	string	false	none
sales_app	integer	false	sales application
dealer_id	string	false	dealer id

Property	Values
operation	one of [CONVERGENT, MOBILE_ONLY, MIGRATION, ADDLINE]

finance_renewal_request

1
2
3
4
5
6
7


{
  "customer_id": "963085b0-f526-4a53-88bc-4d14d8311eaa",
  "account_id": "963085b0-f526-4a53-88bc-4d14d8311eaa",
  "subscription_id": "125474c9-b563-487d-abe1-37106da7d4f6",
  "app_id": 4,
  "dealer_id": "54321"
}

Name	Type	Required	Description
customer_id	string	true	new uuid format used by MasCustomers
account_id	string	true	new uuid format used by MasCustomers
subscription_id	string(int64)	true	uuid legacy id
app_id	integer	true	sales application
dealer_id	string	true	dealer id

finance_renewal_response

 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


{
  "subscription": {
    "subscription_id": "string",
    "subscription_devices": [
      {
        "id": "string",
        "installment_plan_end_date": "string"
      }
    ]
  },
  "total_limits": {
    "credit_limit": 50.5,
    "single_upfront_devices_limit": 0,
    "financed_devices_limit": 0
  },
  "renewal_allowed": true,
  "financed_devices_available_limit": 0,
  "available_credit_limit": 50.5,
  "single_upfront_devices_available_limit": 0,
  "prescoring_id_value": 445322123,
  "prescoring_risk_profile": "ALTO",
  "score_value": "REJECTED",
  "renewal_denied_reason": "NONE",
  "action": "RENEWAL_WITH_TYPE1_AND_CANCEL_PERMANENCY"
}

Name	Type	Required	Description
subscription	subscription	false	none
total_limits	total_limits	false	none
renewal_allowed	boolean	false	none
financed_devices_available_limit	integer	false	none
available_credit_limit	number(double)	false	none
single_upfront_devices_available_limit	integer	false	none
prescoring_id_value	integer(int64)	false	none
prescoring_risk_profile	string	false	none
score_value	string	false	Enum representing score values for different states.
renewal_denied_reason	string	false	none
action	string	false	none

Property	Values
prescoring_risk_profile	one of [ALTO, BAJO, MEDIO, UNKNOWN]
score_value	one of [REJECTED, UNFRONT_REQUIRED, APPROVED, SPECIAL_APPROVED]
renewal_denied_reason	one of [NONE, CONTRACTED_TERMINAL_IN_LOGISTIC_PROCESS_INVALID, CONTRACTED_TERMINAL_IN_PENALIZATION_PERIOD, CONTRACTED_TERMINAL_IN_PENDING_PAYMENT_REVIEW]
action	one of [RENEWAL_WITH_TYPE1_AND_CANCEL_PERMANENCY, RENEWAL_WITH_TYPE1, RENEWAL_WITH_TYPE2]

total_limits

1
2
3
4
5


{
  "credit_limit": 50.5,
  "single_upfront_devices_limit": 0,
  "financed_devices_limit": 0
}

Name	Type	Required	Description
credit_limit	number(double)	false	none
single_upfront_devices_limit	integer	false	none
financed_devices_limit	integer	false	none

subscription

1
2
3
4
5
6
7
8
9


{
  "subscription_id": "string",
  "subscription_devices": [
    {
      "id": "string",
      "installment_plan_end_date": "string"
    }
  ]
}

Name	Type	Required	Description
subscription_id	string	false	none
subscription_devices	[subscription_device]	false	none

subscription_device

1
2
3
4


{
  "id": "string",
  "installment_plan_end_date": "string"
}

Name	Type	Required	Description
id	string	false	none
installment_plan_end_date	string	false	none

territory_owner_type

1

"DIRECT_COVERAGE"

Name	Type	Required	Description
anonymous	string	false	Enum representing both type TO

Property	Values
anonymous	one of [DIRECT_COVERAGE, INDIRECT_COVERAGE, ADSL]