API Overview Resources Schemas

Schemas

PortabilityRequest

 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


{
  "access_type": "INDIVIDUAL",
  "contract_code": "00528902840",
  "external_reference": "PORTIN_902840_634443633",
  "msisdn_ranges": [
    {
      "initial_range": {
        "msisdn": {
          "country_code": "34",
          "number": "634443633"
        },
        "icc_id": "8934221507160508791"
      },
      "end_range": {
        "msisdn": {
          "country_code": "34",
          "number": "634443633"
        },
        "icc_id": "8934221507160508791"
      }
    }
  ],
  "nrn_receptor": "741111",
  "recipient_operator": null,
  "subscriber": {
    "addresses": [
      {
        "address": "Calle Leonardo Prieto, 8",
        "city": "Madrid",
        "country": "Spain",
        "postal_code": "28040",
        "province": "Madrid",
        "type": "CONTACT"
      }
    ],
    "document": "09288205T",
    "document_type": "NIF",
    "id": null,
    "email": null,
    "msisdn": {
      "country_code": "34",
      "number": "634443633"
    },
    "name": "Martina",
    "nationality": "España",
    "second_name": null,
    "surname": "Fraile Méndez"
  },
  "subscriber_request_date": "2022-02-24T13:45:10Z",
  "window_date": null
}

Name	Type	Required	Description
access_type	string	true	Access type of the request. Must be one of these values: [INDIVIDUAL,MULTIPLE,MIXED]
contract_code	string	true	Contract signed by subscriber
external_reference	string	false	External identifier
msisdn_ranges	[MsisdnRanges]	true	List of phone number ranges to port
nrn_receptor	string	true	Network Routing Number of recipient operator. Must match pattern ‘^[\d]{6,6}$’
recipient_operator	string	false	Receiving operator code. Must match pattern ‘^[\d]{3,3}$’
subscriber	Subscriber	false	none
subscriber_request_date	string	false	Date of the portability request. Timestamp in UTC time zone, format yyyy-MM-ddTHH:mm:ssZ
window_date	string	false	Window date of the portability. Timestamp in UTC time zone, format yyyy-MM-ddTHH:mm:ssZ

Property	Values
access_type	one of [INDIVIDUAL, MULTIPLE, MIXED]

DenyPortability

1
2
3


{
  "cause": "string"
}

Name	Type	Required	Description
cause	string	false	none

Portability

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


{
  "access_type": "string",
  "cause_status": "string",
  "contract_code": "string",
  "create_date_nc": "string",
  "donor_operator": "string",
  "external_reference": "string",
  "icc_id": "string",
  "id": "string",
  "message_type": "string",
  "msisdn": "string",
  "nrn_receptor": "string",
  "process_id": "string",
  "recipient_operator": "string",
  "recipient_rol": true,
  "state": "string",
  "tenant": "string",
  "window_date": "string"
}

Name	Type	Required	Description
access_type	string	false	none
cause_status	string	false	none
contract_code	string	false	none
create_date_nc	string	false	none
donor_operator	string	false	none
external_reference	string	false	none
icc_id	string	false	none
id	string	false	none
message_type	string	false	none
msisdn	string	false	none
nrn_receptor	string	false	none
process_id	string	false	none
recipient_operator	string	false	none
recipient_rol	boolean	false	none
state	string	false	none
tenant	string	false	none
window_date	string	false	none

PortabilityDetail

 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


{
  "access_type": "string",
  "cause_status": "string",
  "contract_code": "string",
  "create_date_nc": "string",
  "donor_operator": "string",
  "id": "string",
  "message_type": "string",
  "msisdn": "string",
  "nrn_receptor": "string",
  "portability_events": {
    "account": {
      "cause_status": "string",
      "event_date": "string",
      "id": "string",
      "message_type": "string",
      "notification_code": "string",
      "process_id": "string",
      "recipient_rol": "string"
    }
  },
  "process_id": "string",
  "recipient_operator": "string",
  "recipient_rol": true,
  "state": "string",
  "subscriber": {
    "account": {
      "addresses": [
        {
          "address": "Calle Leonardo Prieto, 8",
          "city": "Madrid",
          "country": "Spain",
          "postal_code": "28040",
          "province": "Madrid",
          "type": "CONTACT"
        }
      ],
      "document": "09288205T",
      "document_type": "NIF",
      "id": null,
      "email": null,
      "msisdn": {
        "country_code": "34",
        "number": "634443633"
      },
      "name": "Martina",
      "nationality": "España",
      "second_name": null,
      "surname": "Fraile Méndez"
    }
  },
  "tenant": "string",
  "window_date": "string"
}

Name	Type	Required	Description
access_type	string	false	none
cause_status	string	false	none
contract_code	string	false	none
create_date_nc	string	false	none
donor_operator	string	false	none
id	string	false	none
message_type	string	false	none
msisdn	string	false	none
nrn_receptor	string	false	none
portability_events	object	false	none
» account	PortabilityEvent	false	none
process_id	string	false	none
recipient_operator	string	false	none
recipient_rol	boolean	false	none
state	string	false	none
subscriber	object	false	none
» account	Subscriber	false	none
tenant	string	false	none
window_date	string	false	none

PortabilityEvent

1
2
3
4
5
6
7
8
9


{
  "cause_status": "string",
  "event_date": "string",
  "id": "string",
  "message_type": "string",
  "notification_code": "string",
  "process_id": "string",
  "recipient_rol": "string"
}

Name	Type	Required	Description
cause_status	string	false	none
event_date	string	false	none
id	string	false	none
message_type	string	false	none
notification_code	string	false	none
process_id	string	false	none
recipient_rol	string	false	none

MsisdnRanges

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


{
  "initial_range": {
    "msisdn": {
      "country_code": "34",
      "number": "634443633"
    },
    "icc_id": "8934221507160508791"
  },
  "end_range": {
    "msisdn": {
      "country_code": "34",
      "number": "634443633"
    },
    "icc_id": "8934221507160508791"
  }
}

Name	Type	Required	Description
initial_range	MsisdnInfo	true	none
end_range	MsisdnInfo	false	none

MsisdnInfo

1
2
3
4
5
6
7


{
  "msisdn": {
    "country_code": "34",
    "number": "634443633"
  },
  "icc_id": "8934221507160508791"
}

Name	Type	Required	Description
msisdn	PhoneNumber	true	none
icc_id	string	false	Line identifier. Must match pattern ‘^[0-9A-Za-z]{19,20}$’

PhoneNumber

1
2
3
4


{
  "country_code": "34",
  "number": "634443633"
}

Name	Type	Required	Description
country_code	string	false	Country code, without the ‘+’. Must match pattern ‘^[\d]{1,3}$’
number	string	true	Phone number inside the national network. Must match pattern ‘^[\d]{4,14}$’

Subscriber

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


{
  "addresses": [
    {
      "address": "Calle Leonardo Prieto, 8",
      "city": "Madrid",
      "country": "Spain",
      "postal_code": "28040",
      "province": "Madrid",
      "type": "CONTACT"
    }
  ],
  "document": "09288205T",
  "document_type": "NIF",
  "id": null,
  "email": null,
  "msisdn": {
    "country_code": "34",
    "number": "634443633"
  },
  "name": "Martina",
  "nationality": "España",
  "second_name": null,
  "surname": "Fraile Méndez"
}

Name	Type	Required	Description
addresses	[Address]	false	Subscriber addresses information
document	string	false	Identity document number
document_type	string	false	Identity document type. Must be one of these values: [NIF,DNI,CIF,NIE,PASSPORT,TR]
id	string	false	Subscriber id
email	string	false	Subscriber email
msisdn	PhoneNumber	false	none
name	string	false	Subscriber name
nationality	string	false	Subscriber nationality
second_name	string	false	Subscriber second name
surname	string	false	Subscriber surname

Property	Values
document_type	one of [NIF, DNI, CIF, NIE, PASSPORT, TR]

Address

1
2
3
4
5
6
7
8


{
  "address": "Calle Leonardo Prieto, 8",
  "city": "Madrid",
  "country": "Spain",
  "postal_code": "28040",
  "province": "Madrid",
  "type": "CONTACT"
}

Name	Type	Required	Description
address	string	false	Name of street, road, avenue…
city	string	false	Address city
country	string	false	Address country
postal_code	string	false	Address zipcode
province	string	false	Address province
type	string	false	Type of address. Must be one of these values: [BILLING,INSTALLATION,CONTACT]

Property	Values
type	one of [BILLING, INSTALLATION, CONTACT]

OwnerOperator

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


{
  "msisdn": "string",
  "nrn": "string",
  "codigoOperadorActual": "string",
  "codigoOperadorPropietarioRango": "string",
  "involucradaProcesoPortabilidad": true,
  "portada": true,
  "codigoReferenciaSolicitudPortabilidadMovil": "string",
  "codigoReferenciaIncidencia": [
    "string"
  ]
}

Name	Type	Required	Description
msisdn	string	false	none
nrn	string	false	none
codigoOperadorActual	string	false	none
codigoOperadorPropietarioRango	string	false	none
involucradaProcesoPortabilidad	boolean	false	none
portada	boolean	false	none
codigoReferenciaSolicitudPortabilidadMovil	string	false	none
codigoReferenciaIncidencia	[string]	false	none

OperatorConfigs

 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


[
  {
    "id": 4,
    "operator": "YOIGO",
    "operator_code": "005",
    "nrn_range": [
      {
        "id": 0,
        "initial_nrn": 900053,
        "final_nrn": 900056
      }
    ],
    "network_operator": "003",
    "msisdn_range": [
      {
        "id": 0,
        "initial_msisdn": 600000000,
        "final_msisdn": 600000001
      }
    ],
    "individual_quota": "A",
    "multiple_quota": 50,
    "change_quota": 1000,
    "status": "ACTIVO",
    "status_date": "2024-01-30T10:00:00Z",
    "backup": false
  }
]

Name	Type	Required	Description
anonymous	[OperatorConfig]	false	none

OperatorConfig

 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


{
  "id": 4,
  "operator": "YOIGO",
  "operator_code": "005",
  "nrn_range": [
    {
      "id": 0,
      "initial_nrn": 900053,
      "final_nrn": 900056
    }
  ],
  "network_operator": "003",
  "msisdn_range": [
    {
      "id": 0,
      "initial_msisdn": 600000000,
      "final_msisdn": 600000001
    }
  ],
  "individual_quota": "A",
  "multiple_quota": 50,
  "change_quota": 1000,
  "status": "ACTIVO",
  "status_date": "2024-01-30T10:00:00Z",
  "backup": false
}

Name	Type	Required	Description
id	integer(int64)	false	Operator Config id
operator	string	false	The operator name
operator_code	string	false	The operator code
nrn_range	OperatorRangeNrns	false	none
network_operator	string	false	Network operator code
msisdn_range	OperatorRangeMsisdns	false	none
individual_quota	string	false	Character representing the group of maximum daily individual portability requests the operator belongs to.
multiple_quota	integer	false	Maximum daily number of multiple portability requests allowed by the operator.
change_quota	integer	false	Maximum daily number of changes allowed by the operator as donor rol.
status	string	false	Operator status. Must be in: [ACTIVO,DESHABILITADO,ALTA_EXTRAORDINARIA]
status_date	string(date-time)	false	Operator status change date
backup	boolean	false	Whether the entry is backed up or not.

Property	Values
status	one of [ACTIVO, DESHABILITADO, ALTA_EXTRAORDINARIA]

OperatorRangeNrns

1
2
3
4
5
6
7


[
  {
    "id": 0,
    "initial_nrn": 900053,
    "final_nrn": 900056
  }
]

Name	Type	Required	Description
anonymous	[OperatorRangeNrn]	false	[Operator config range of Network Routing Numbers]

OperatorRangeNrn

1
2
3
4
5


{
  "id": 0,
  "initial_nrn": 900053,
  "final_nrn": 900056
}

Name	Type	Required	Description
id	integer(int64)	false	The range id
initial_nrn	string	false	Initial value of the range
final_nrn	string	false	Final value of the range

OperatorRangeMsisdns

1
2
3
4
5
6
7


[
  {
    "id": 0,
    "initial_msisdn": 600000000,
    "final_msisdn": 600000001
  }
]

Name	Type	Required	Description
anonymous	[OperatorRangeMsisdn]	false	[Operator config range of msisdns]

OperatorRangeMsisdn

1
2
3
4
5


{
  "id": 0,
  "initial_msisdn": 600000000,
  "final_msisdn": 600000001
}

Name	Type	Required	Description
id	integer(int64)	false	The range id
initial_msisdn	string	false	Initial value of the range
final_msisdn	string	false	Final value of the range