Signups

Access to signups new clients


Parameters

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

Request body - instance of SignupsRequest

  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
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
{
  "sales_type": "telecomunications",
  "sales_info": {
    "channel": "dealer",
    "dealer_id": "string",
    "shop_id": "string",
    "agent_id": "string",
    "logistic": true,
    "signature_process_id": 0,
    "signature_type": "PAPER",
    "channel_id": 0
  },
  "clients": {
    "sector_id": 1,
    "attributes": [
      {
        "type": "existing",
        "document_type_id": 1,
        "document_value": "11111111A",
        "document_expiration_date": "1999-01-31",
        "employment": {
          "activity_country_code": "st",
          "company": "string",
          "income": 9999999999999.99,
          "income_source": {
            "id": 999999999,
            "observations": "string"
          },
          "profession": 999999999,
          "professional_area": 999999999,
          "professional_use": true
        }
      }
    ]
  },
  "payment": {
    "billing_type_id": 1,
    "scoring": {
      "scoring_value": 0,
      "id_value": 0,
      "forced_value": 0,
      "up_front": 0.1,
      "credit_limit": 0.1,
      "credit_limit_available": 0.1,
      "app_id": 0
    },
    "info": {
      "bank_account": "string",
      "swift_bic": "string"
    },
    "tpv_response": {
      "amount": "string",
      "card_number": "000000******0000",
      "expiry_date": "0121",
      "transaction_id": "1563B44RPR2",
      "reference_id": "string",
      "platform": "PAYMENTS",
      "payment_link": "string",
      "tax": 21
    },
    "account_number": "string"
  },
  "products": {
    "mobile_line": {
      "existing_number": false,
      "type": "mobile",
      "product_id": 214748364,
      "portability_info": {
        "scheduled_date": "2020-04-20",
        "iccid": "string",
        "operator_id": "string",
        "operation_type": 1,
        "initial_date_operation": "1999-01-31",
        "donor_line_type": "C",
        "donor_user": {
          "type": "existing",
          "document_type_id": 1,
          "document_value": "11111111A"
        },
        "internal_portability": true,
        "installation_required": true
      },
      "msisdn": "string",
      "iccid": "string",
      "fabrication_type_sim_id": 214748364,
      "initial_balance": 0.1,
      "bonuses": [
        {
          "id": 0
        }
      ],
      "promotions": [
        {
          "id": 0,
          "value": "string"
        }
      ],
      "terminals": [
        {
          "id": 0,
          "financed": true,
          "imei": "string",
          "serial_number": "string"
        }
      ],
      "wants_communications": true,
      "expedition_info": {
        "language_id": 214748364,
        "nationality_id": 214748364,
        "name": "John",
        "middlename": "Nicholas",
        "lastname": "Doe",
        "document_type_id": 1,
        "document_value": "11111111A",
        "email": "john.doe@example.com",
        "birthdate": "1999-01-31",
        "contact_phone": "string",
        "gender": "M",
        "address": {
          "street_name": "string",
          "state_id": 0,
          "locality": "string",
          "postal_code": "string",
          "country": "string",
          "number": "string",
          "value": "Castellano"
        }
      },
      "delivery_info": {
        "contact": {
          "name": "string",
          "middlename": "string",
          "lastname": "string",
          "phone": "string",
          "email": "string",
          "document_type_id": 0,
          "document_value": "string"
        },
        "address": {
          "street_type_id": 0,
          "street_name": "string",
          "number": "string",
          "supplement": "string",
          "state_id": 0,
          "locality": "string",
          "postal_code": "string",
          "observation": "string"
        },
        "delivery_shop_id": "0025",
        "delivery_type": "LOGISTIC"
      },
      "devices": [
        {
          "device_details": {
            "id": 0,
            "model_id": "string",
            "cession_price": 999999999.99,
            "imei": "string",
            "pending_imei": true,
            "insured_amount": 0.01,
            "category": "string",
            "logistic_required": true,
            "catalogue_id": "string",
            "amount": 0.01
          },
          "fees": {
            "upfront_fee": 999999999.99,
            "installment_plan": {
              "commission": 999999999.99,
              "tae": 999999999.99,
              "tin": 999999999.99,
              "duration": 1,
              "monthly_fee": 999999999.99,
              "last_installment_fee": 999999999.99,
              "discount_final_payment_value": 999999999.99,
              "is_promotional_renew": true
            }
          },
          "financial_details": {
            "pre_booking": {
              "order_id": "string",
              "authorization_id": "string",
              "financial_entity": "string",
              "status": "Accepted",
              "granted_amount": 999999999,
              "credit_line_amount": 999999999,
              "total_client_financed_value": 999999999.99
            },
            "consents": {
              "commercial": true,
              "gdpr": true
            }
          },
          "campaign_id": 0,
          "terms": {
            "penalty_value": 999999999.99,
            "commitment_duration": 9999
          },
          "reservation_id": 0,
          "signature_process_id": 0,
          "signature_type": "PAPER",
          "old_subscription_terminal_id": 0
        }
      ]
    },
    "bundle": {
      "bundle_id": 0,
      "territory_owner": "string",
      "promotions": [
        {
          "id": 0,
          "value": "string"
        }
      ],
      "installation_info": {
        "contact": {
          "name": "string",
          "middlename": "string",
          "lastname": "string",
          "phone": "string",
          "email": "string",
          "document_type_id": 0,
          "document_value": "string"
        },
        "address": {
          "street_type_id": 0,
          "street_name": "string",
          "number": "string",
          "supplement": "string",
          "state_id": 0,
          "locality": "string",
          "postal_code": "string",
          "gescal": "stringstringstrin",
          "pair_vacancy": true,
          "address_id": "string"
        }
      },
      "delivery_info": {
        "contact": {
          "name": "string",
          "middlename": "string",
          "lastname": "string",
          "phone": "string",
          "email": "string",
          "document_type_id": 0,
          "document_value": "string"
        },
        "address": {
          "street_type_id": 0,
          "street_name": "string",
          "number": "string",
          "supplement": "string",
          "state_id": 0,
          "locality": "string",
          "postal_code": "string",
          "observation": "string"
        },
        "delivery_shop_id": "0025",
        "delivery_type": "LOGISTIC"
      },
      "landline": {
        "product_id": 0,
        "portability_info": {
          "scheduled_date": "2020-04-20",
          "iccid": "string",
          "operator_id": "string",
          "operation_type": 1,
          "initial_date_operation": "1999-01-31",
          "donor_line_type": "C",
          "donor_user": {
            "type": "existing",
            "document_type_id": 1,
            "document_value": "11111111A"
          },
          "internal_portability": true,
          "installation_required": true
        },
        "number": "string",
        "bonuses": [
          {
            "id": 0
          }
        ],
        "promotions": [
          {
            "id": 0,
            "value": "string"
          }
        ],
        "services": [
          {
            "id": 0
          }
        ],
        "wants_communications": true
      },
      "ftth": {
        "product_id": 0,
        "promotions": [
          {
            "id": 0,
            "value": "string"
          }
        ],
        "connection_type": "string",
        "installer": "string",
        "iua": "string",
        "terminals": [
          {
            "id": 0,
            "financed": true,
            "imei": "string",
            "serial_number": "string"
          }
        ],
        "wants_communications": true,
        "access_reuse": "Interno",
        "access_reuse_choice": true
      },
      "adsl": {
        "product_id": 0,
        "promotions": [
          {
            "id": 0,
            "value": "string"
          }
        ],
        "wants_communications": true,
        "install_tech_support": true,
        "tech_support_billiable": true
      },
      "mobile_lines": [
        {
          "existing_number": false,
          "type": "mobile",
          "product_id": 214748364,
          "portability_info": {
            "scheduled_date": "2020-04-20",
            "iccid": "string",
            "operator_id": "string",
            "operation_type": 1,
            "initial_date_operation": "1999-01-31",
            "donor_line_type": "C",
            "donor_user": {
              "type": "existing",
              "document_type_id": 1,
              "document_value": "11111111A"
            },
            "internal_portability": true,
            "installation_required": true
          },
          "msisdn": "string",
          "iccid": "string",
          "fabrication_type_sim_id": 214748364,
          "initial_balance": 0.1,
          "bonuses": [
            {
              "id": 0
            }
          ],
          "promotions": [
            {
              "id": 0,
              "value": "string"
            }
          ],
          "terminals": [
            {
              "id": 0,
              "financed": true,
              "imei": "string",
              "serial_number": "string"
            }
          ],
          "wants_communications": true,
          "expedition_info": {
            "language_id": 214748364,
            "nationality_id": 214748364,
            "name": "John",
            "middlename": "Nicholas",
            "lastname": "Doe",
            "document_type_id": 1,
            "document_value": "11111111A",
            "email": "john.doe@example.com",
            "birthdate": "1999-01-31",
            "contact_phone": "string",
            "gender": "M",
            "address": {
              "street_name": "string",
              "state_id": 0,
              "locality": "string",
              "postal_code": "string",
              "country": "string",
              "number": "string",
              "value": "Castellano"
            }
          },
          "delivery_info": {
            "contact": {
              "name": "string",
              "middlename": "string",
              "lastname": "string",
              "phone": "string",
              "email": "string",
              "document_type_id": 0,
              "document_value": "string"
            },
            "address": {
              "street_type_id": 0,
              "street_name": "string",
              "number": "string",
              "supplement": "string",
              "state_id": 0,
              "locality": "string",
              "postal_code": "string",
              "observation": "string"
            },
            "delivery_shop_id": "0025",
            "delivery_type": "LOGISTIC"
          },
          "devices": [
            {
              "device_details": {
                "id": 0,
                "model_id": "string",
                "cession_price": 999999999.99,
                "imei": "string",
                "pending_imei": true,
                "insured_amount": 0.01,
                "category": "string",
                "logistic_required": true,
                "catalogue_id": "string",
                "amount": 0.01
              },
              "fees": {
                "upfront_fee": 999999999.99,
                "installment_plan": {
                  "commission": 999999999.99,
                  "tae": 999999999.99,
                  "tin": 999999999.99,
                  "duration": 1,
                  "monthly_fee": 999999999.99,
                  "last_installment_fee": 999999999.99,
                  "discount_final_payment_value": 999999999.99,
                  "is_promotional_renew": true
                }
              },
              "financial_details": {
                "pre_booking": {
                  "order_id": "string",
                  "authorization_id": "string",
                  "financial_entity": "string",
                  "status": "Accepted",
                  "granted_amount": 999999999,
                  "credit_line_amount": 999999999,
                  "total_client_financed_value": 999999999.99
                },
                "consents": {
                  "commercial": true,
                  "gdpr": true
                }
              },
              "campaign_id": 0,
              "terms": {
                "penalty_value": 999999999.99,
                "commitment_duration": 9999
              },
              "reservation_id": 0,
              "signature_process_id": 0,
              "signature_type": "PAPER",
              "old_subscription_terminal_id": 0
            }
          ]
        }
      ],
      "tv": {
        "product_id": 0,
        "number_associated": "string",
        "registration_email": "string",
        "contact_phone": "string",
        "install_tech_support": true,
        "promotions": [
          {
            "id": 0,
            "value": "string"
          }
        ],
        "terminals": [
          {
            "id": 0,
            "financed": true,
            "imei": "string",
            "serial_number": "string"
          }
        ]
      },
      "ott": [
        {
          "product_id": 0,
          "email": "string",
          "promotions": [
            {
              "id": 0,
              "value": "string"
            }
          ]
        }
      ]
    }
  }
}
Name Type Required Description
sales_type string true none
sales_info SalesInfo true none
clients SignupClients true none
payment SignupsPayment true none
products Products true none
Property Values
sales_type one of [telecomunications]

Request 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
 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
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517

curl -X POST https://customers.sta.masstack.com/v2/orgs/telco/signups \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY" \
 --data-raw "{
  'sales_type': 'telecomunications',
  'sales_info': {
    'channel': 'dealer',
    'dealer_id': 'string',
    'shop_id': 'string',
    'agent_id': 'string',
    'logistic': true,
    'signature_process_id': 0,
    'signature_type': 'PAPER',
    'channel_id': 0
  },
  'clients': {
    'sector_id': 1,
    'attributes': [
      {
        'type': 'existing',
        'document_type_id': 1,
        'document_value': '11111111A',
        'document_expiration_date': '1999-01-31',
        'employment': {
          'activity_country_code': 'st',
          'company': 'string',
          'income': 9999999999999.99,
          'income_source': {
            'id': 999999999,
            'observations': 'string'
          },
          'profession': 999999999,
          'professional_area': 999999999,
          'professional_use': true
        }
      }
    ]
  },
  'payment': {
    'billing_type_id': 1,
    'scoring': {
      'scoring_value': 0,
      'id_value': 0,
      'forced_value': 0,
      'up_front': 0.1,
      'credit_limit': 0.1,
      'credit_limit_available': 0.1,
      'app_id': 0
    },
    'info': {
      'bank_account': 'string',
      'swift_bic': 'string'
    },
    'tpv_response': {
      'amount': 'string',
      'card_number': '000000******0000',
      'expiry_date': '0121',
      'transaction_id': '1563B44RPR2',
      'reference_id': 'string',
      'platform': 'PAYMENTS',
      'payment_link': 'string',
      'tax': 21
    },
    'account_number': 'string'
  },
  'products': {
    'mobile_line': {
      'existing_number': false,
      'type': 'mobile',
      'product_id': 214748364,
      'portability_info': {
        'scheduled_date': '2020-04-20',
        'iccid': 'string',
        'operator_id': 'string',
        'operation_type': 1,
        'initial_date_operation': '1999-01-31',
        'donor_line_type': 'C',
        'donor_user': {
          'type': 'existing',
          'document_type_id': 1,
          'document_value': '11111111A'
        },
        'internal_portability': true,
        'installation_required': true
      },
      'msisdn': 'string',
      'iccid': 'string',
      'fabrication_type_sim_id': 214748364,
      'initial_balance': 0.1,
      'bonuses': [
        {
          'id': 0
        }
      ],
      'promotions': [
        {
          'id': 0,
          'value': 'string'
        }
      ],
      'terminals': [
        {
          'id': 0,
          'financed': true,
          'imei': 'string',
          'serial_number': 'string'
        }
      ],
      'wants_communications': true,
      'expedition_info': {
        'language_id': 214748364,
        'nationality_id': 214748364,
        'name': 'John',
        'middlename': 'Nicholas',
        'lastname': 'Doe',
        'document_type_id': 1,
        'document_value': '11111111A',
        'email': 'john.doe@example.com',
        'birthdate': '1999-01-31',
        'contact_phone': 'string',
        'gender': 'M',
        'address': {
          'street_name': 'string',
          'state_id': 0,
          'locality': 'string',
          'postal_code': 'string',
          'country': 'string',
          'number': 'string',
          'value': 'Castellano'
        }
      },
      'delivery_info': {
        'contact': {
          'name': 'string',
          'middlename': 'string',
          'lastname': 'string',
          'phone': 'string',
          'email': 'string',
          'document_type_id': 0,
          'document_value': 'string'
        },
        'address': {
          'street_type_id': 0,
          'street_name': 'string',
          'number': 'string',
          'supplement': 'string',
          'state_id': 0,
          'locality': 'string',
          'postal_code': 'string',
          'observation': 'string'
        },
        'delivery_shop_id': '0025',
        'delivery_type': 'LOGISTIC'
      },
      'devices': [
        {
          'device_details': {
            'id': 0,
            'model_id': 'string',
            'cession_price': 999999999.99,
            'imei': 'string',
            'pending_imei': true,
            'insured_amount': 0.01,
            'category': 'string',
            'logistic_required': true,
            'catalogue_id': 'string',
            'amount': 0.01
          },
          'fees': {
            'upfront_fee': 999999999.99,
            'installment_plan': {
              'commission': 999999999.99,
              'tae': 999999999.99,
              'tin': 999999999.99,
              'duration': 1,
              'monthly_fee': 999999999.99,
              'last_installment_fee': 999999999.99,
              'discount_final_payment_value': 999999999.99,
              'is_promotional_renew': true
            }
          },
          'financial_details': {
            'pre_booking': {
              'order_id': 'string',
              'authorization_id': 'string',
              'financial_entity': 'string',
              'status': 'Accepted',
              'granted_amount': 999999999,
              'credit_line_amount': 999999999,
              'total_client_financed_value': 999999999.99
            },
            'consents': {
              'commercial': true,
              'gdpr': true
            }
          },
          'campaign_id': 0,
          'terms': {
            'penalty_value': 999999999.99,
            'commitment_duration': 9999
          },
          'reservation_id': 0,
          'signature_process_id': 0,
          'signature_type': 'PAPER',
          'old_subscription_terminal_id': 0
        }
      ]
    },
    'bundle': {
      'bundle_id': 0,
      'territory_owner': 'string',
      'promotions': [
        {
          'id': 0,
          'value': 'string'
        }
      ],
      'installation_info': {
        'contact': {
          'name': 'string',
          'middlename': 'string',
          'lastname': 'string',
          'phone': 'string',
          'email': 'string',
          'document_type_id': 0,
          'document_value': 'string'
        },
        'address': {
          'street_type_id': 0,
          'street_name': 'string',
          'number': 'string',
          'supplement': 'string',
          'state_id': 0,
          'locality': 'string',
          'postal_code': 'string',
          'gescal': 'stringstringstrin',
          'pair_vacancy': true,
          'address_id': 'string'
        }
      },
      'delivery_info': {
        'contact': {
          'name': 'string',
          'middlename': 'string',
          'lastname': 'string',
          'phone': 'string',
          'email': 'string',
          'document_type_id': 0,
          'document_value': 'string'
        },
        'address': {
          'street_type_id': 0,
          'street_name': 'string',
          'number': 'string',
          'supplement': 'string',
          'state_id': 0,
          'locality': 'string',
          'postal_code': 'string',
          'observation': 'string'
        },
        'delivery_shop_id': '0025',
        'delivery_type': 'LOGISTIC'
      },
      'landline': {
        'product_id': 0,
        'portability_info': {
          'scheduled_date': '2020-04-20',
          'iccid': 'string',
          'operator_id': 'string',
          'operation_type': 1,
          'initial_date_operation': '1999-01-31',
          'donor_line_type': 'C',
          'donor_user': {
            'type': 'existing',
            'document_type_id': 1,
            'document_value': '11111111A'
          },
          'internal_portability': true,
          'installation_required': true
        },
        'number': 'string',
        'bonuses': [
          {
            'id': 0
          }
        ],
        'promotions': [
          {
            'id': 0,
            'value': 'string'
          }
        ],
        'services': [
          {
            'id': 0
          }
        ],
        'wants_communications': true
      },
      'ftth': {
        'product_id': 0,
        'promotions': [
          {
            'id': 0,
            'value': 'string'
          }
        ],
        'connection_type': 'string',
        'installer': 'string',
        'iua': 'string',
        'terminals': [
          {
            'id': 0,
            'financed': true,
            'imei': 'string',
            'serial_number': 'string'
          }
        ],
        'wants_communications': true,
        'access_reuse': 'Interno',
        'access_reuse_choice': true
      },
      'adsl': {
        'product_id': 0,
        'promotions': [
          {
            'id': 0,
            'value': 'string'
          }
        ],
        'wants_communications': true,
        'install_tech_support': true,
        'tech_support_billiable': true
      },
      'mobile_lines': [
        {
          'existing_number': false,
          'type': 'mobile',
          'product_id': 214748364,
          'portability_info': {
            'scheduled_date': '2020-04-20',
            'iccid': 'string',
            'operator_id': 'string',
            'operation_type': 1,
            'initial_date_operation': '1999-01-31',
            'donor_line_type': 'C',
            'donor_user': {
              'type': 'existing',
              'document_type_id': 1,
              'document_value': '11111111A'
            },
            'internal_portability': true,
            'installation_required': true
          },
          'msisdn': 'string',
          'iccid': 'string',
          'fabrication_type_sim_id': 214748364,
          'initial_balance': 0.1,
          'bonuses': [
            {
              'id': 0
            }
          ],
          'promotions': [
            {
              'id': 0,
              'value': 'string'
            }
          ],
          'terminals': [
            {
              'id': 0,
              'financed': true,
              'imei': 'string',
              'serial_number': 'string'
            }
          ],
          'wants_communications': true,
          'expedition_info': {
            'language_id': 214748364,
            'nationality_id': 214748364,
            'name': 'John',
            'middlename': 'Nicholas',
            'lastname': 'Doe',
            'document_type_id': 1,
            'document_value': '11111111A',
            'email': 'john.doe@example.com',
            'birthdate': '1999-01-31',
            'contact_phone': 'string',
            'gender': 'M',
            'address': {
              'street_name': 'string',
              'state_id': 0,
              'locality': 'string',
              'postal_code': 'string',
              'country': 'string',
              'number': 'string',
              'value': 'Castellano'
            }
          },
          'delivery_info': {
            'contact': {
              'name': 'string',
              'middlename': 'string',
              'lastname': 'string',
              'phone': 'string',
              'email': 'string',
              'document_type_id': 0,
              'document_value': 'string'
            },
            'address': {
              'street_type_id': 0,
              'street_name': 'string',
              'number': 'string',
              'supplement': 'string',
              'state_id': 0,
              'locality': 'string',
              'postal_code': 'string',
              'observation': 'string'
            },
            'delivery_shop_id': '0025',
            'delivery_type': 'LOGISTIC'
          },
          'devices': [
            {
              'device_details': {
                'id': 0,
                'model_id': 'string',
                'cession_price': 999999999.99,
                'imei': 'string',
                'pending_imei': true,
                'insured_amount': 0.01,
                'category': 'string',
                'logistic_required': true,
                'catalogue_id': 'string',
                'amount': 0.01
              },
              'fees': {
                'upfront_fee': 999999999.99,
                'installment_plan': {
                  'commission': 999999999.99,
                  'tae': 999999999.99,
                  'tin': 999999999.99,
                  'duration': 1,
                  'monthly_fee': 999999999.99,
                  'last_installment_fee': 999999999.99,
                  'discount_final_payment_value': 999999999.99,
                  'is_promotional_renew': true
                }
              },
              'financial_details': {
                'pre_booking': {
                  'order_id': 'string',
                  'authorization_id': 'string',
                  'financial_entity': 'string',
                  'status': 'Accepted',
                  'granted_amount': 999999999,
                  'credit_line_amount': 999999999,
                  'total_client_financed_value': 999999999.99
                },
                'consents': {
                  'commercial': true,
                  'gdpr': true
                }
              },
              'campaign_id': 0,
              'terms': {
                'penalty_value': 999999999.99,
                'commitment_duration': 9999
              },
              'reservation_id': 0,
              'signature_process_id': 0,
              'signature_type': 'PAPER',
              'old_subscription_terminal_id': 0
            }
          ]
        }
      ],
      'tv': {
        'product_id': 0,
        'number_associated': 'string',
        'registration_email': 'string',
        'contact_phone': 'string',
        'install_tech_support': true,
        'promotions': [
          {
            'id': 0,
            'value': 'string'
          }
        ],
        'terminals': [
          {
            'id': 0,
            'financed': true,
            'imei': 'string',
            'serial_number': 'string'
          }
        ]
      },
      'ott': [
        {
          'product_id': 0,
          'email': 'string',
          'promotions': [
            {
              'id': 0,
              'value': 'string'
            }
          ]
        }
      ]
    }
  }
}" 

Responses

Code Meaning Description Schema
200 OK signup ok SignupsResponse
202 Accepted Check the risk decision SignupsResponse
400 Bad Request Invalid request body ErrorMessage

Parameters

Name In Type Required Description
orgId path string true organization name
dealerId query string false (optional) dealer identifier

Request example

1
2
3
4
5

curl -X GET https://customers.sta.masstack.com/v2/orgs/telco/signups/master-data?dealerId='string' \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code Meaning Description Schema
200 OK successful operation SignupsMasterData

Parameters

Name In Type Required Description
orgId path string true organization name
host_cfg path string true network id (YOIGO)

Enumerated Values

Property Values
host_cfg one of [YOIGO, ORANGE]

Request example

1
2
3
4
5

curl -X GET https://customers.sta.masstack.com/v2/orgs/telco/signups/available-msisdns/{host_cfg} \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code Meaning Description Schema
200 OK successful operation AvailableMsisdns
400 Bad Request Invalid request body ErrorMessage

Parameters

Name In Type Required Description
orgId path string true organization name
iccid path string true icc

Request example

1
2
3
4
5

curl -X GET https://customers.sta.masstack.com/v2/orgs/telco/signups/simcard-info/{iccid} \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code Meaning Description Schema
200 OK successful operation SimcardInfoResponse

Parameters

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

Request body - instance of RegisterSellPayment

1
2
3
4
5
6
7
8
9
{
  "sell_id": "string",
  "credit_card_number": "000000******0000",
  "validity_date": "0121",
  "sell_value": 0.1,
  "tax": 21,
  "transaction_id": "9651BHUZ2A3",
  "reference_id": "string"
}
Name Type Required Description
sell_id string true none
credit_card_number string false If this value is present, the rest of parameters must be informed
validity_date string false none
sell_value number(double) false none
tax number(double) false none
transaction_id string false none
reference_id string false none

Request example

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

curl -X POST https://customers.sta.masstack.com/v2/orgs/telco/signups/register-sell-payment \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY" \
 --data-raw "{
  'sell_id': 'string',
  'credit_card_number': '000000******0000',
  'validity_date': '0121',
  'sell_value': 0.1,
  'tax': 21,
  'transaction_id': '9651BHUZ2A3',
  'reference_id': 'string'
}" 

Responses

Code Meaning Description Schema
200 OK register successful None
400 Bad Request Invalid request body ErrorMessage

400 - instance of ErrorMessage

Custom schema example

1
2
3
4
5
6
{
  "code": 0,
  "status": "string",
  "message": "string",
  "detailMsg": "string"
}
Name Type Required Description
code integer(int32) false Custom error code
status string false Status
message string false Status message
detailMsg string false Detailed description of the error

Parameters

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

Request body - instance of ActivateSim

1
2
3
4
{
  "msisdn": "string",
  "activation_type": 0
}
Name Type Required Description
msisdn string true Phone number
activation_type number(int32) false none

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

curl -X PATCH https://customers.sta.masstack.com/v2/orgs/telco/signups/activate-sim \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY" \
 --data-raw "{
  'msisdn': 'string',
  'activation_type': 0
}" 

Responses

Code Meaning Description Schema
200 OK activate successful None
400 Bad Request Invalid request body ErrorMessage

400 - instance of ErrorMessage

Custom schema example

1
2
3
4
5
6
{
  "code": 0,
  "status": "string",
  "message": "string",
  "detailMsg": "string"
}
Name Type Required Description
code integer(int32) false Custom error code
status string false Status
message string false Status message
detailMsg string false Detailed description of the error

Parameters

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

Request body - instance of AddLineToBundleRequest

  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
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
{
  "client": {
    "attributes": {
      "document_expiration_date": "1999-01-31",
      "employment": {
        "activity_country_code": "st",
        "company": "string",
        "income": 9999999999999.99,
        "income_source": {
          "id": 999999999,
          "observations": "string"
        },
        "profession": 999999999,
        "professional_area": 999999999,
        "professional_use": true
      }
    }
  },
  "sales_info": {
    "channel": "dealer",
    "dealer_id": "string",
    "shop_id": "string",
    "agent_id": "string",
    "logistic": true,
    "signature_process_id": 0,
    "signature_type": "PAPER",
    "channel_id": 0
  },
  "account": {
    "account_id": 0,
    "subscriptions": {
      "mobile_lines": [
        {
          "type": "additional",
          "product_id": 0,
          "msisdn": 12345,
          "iccid": "8934042419120320845",
          "fabrication_type_sim_id": 214748364,
          "portability_info": {
            "iccid": "8934042419120320845",
            "operator_id": 214748364,
            "operation_type": 1,
            "initial_date_operation": "1999-01-31",
            "donor_line_type": "C",
            "internal_portability": true,
            "installation_required": true,
            "donor_user": {
              "type": "existing",
              "document_type_id": 1,
              "document_value": "11111111A"
            }
          },
          "bonuses": [
            {
              "id": 0
            }
          ],
          "promotions": [
            {
              "id": 0,
              "value": "string"
            }
          ],
          "terminals": [
            {
              "id": 0,
              "financed": true,
              "imei": "string",
              "serial_number": "string"
            }
          ],
          "devices": [
            {
              "device_details": {
                "id": 0,
                "model_id": "string",
                "cession_price": 999999999.99,
                "imei": "string",
                "pending_imei": true,
                "insured_amount": 0.01,
                "category": "string",
                "logistic_required": true,
                "catalogue_id": "string",
                "amount": 0.01
              },
              "fees": {
                "upfront_fee": 999999999.99,
                "installment_plan": {
                  "commission": 999999999.99,
                  "tae": 999999999.99,
                  "tin": 999999999.99,
                  "duration": 1,
                  "monthly_fee": 999999999.99,
                  "last_installment_fee": 999999999.99,
                  "discount_final_payment_value": 999999999.99,
                  "is_promotional_renew": true
                }
              },
              "financial_details": {
                "pre_booking": {
                  "order_id": "string",
                  "authorization_id": "string",
                  "financial_entity": "string",
                  "status": "Accepted",
                  "granted_amount": 999999999,
                  "credit_line_amount": 999999999,
                  "total_client_financed_value": 999999999.99
                },
                "consents": {
                  "commercial": true,
                  "gdpr": true
                }
              },
              "campaign_id": 0,
              "terms": {
                "penalty_value": 999999999.99,
                "commitment_duration": 9999
              },
              "reservation_id": 0,
              "signature_process_id": 0,
              "signature_type": "PAPER",
              "old_subscription_terminal_id": 0
            }
          ],
          "expedition_info": {
            "language_id": 214748364,
            "nationality_id": 214748364,
            "name": "John",
            "middlename": "Nicholas",
            "lastname": "Doe",
            "document_type_id": 1,
            "document_value": "11111111A",
            "email": "john.doe@example.com",
            "birthdate": "1999-01-31",
            "contact_phone": "string",
            "gender": "M",
            "address": {
              "street_name": "string",
              "state_id": 0,
              "locality": "string",
              "postal_code": "string",
              "country": "string",
              "number": "string",
              "value": "Castellano"
            },
            "delivery_shop_id": "0025",
            "delivery_type": "LOGISTIC"
          }
        }
      ],
      "tv": {
        "product_id": 0,
        "number_associated": 12345,
        "registration_email": "string",
        "contact_phone": 12345,
        "promotions": [
          {
            "id": 0,
            "value": "string"
          }
        ],
        "terminals": [
          {
            "id": 0,
            "financed": true,
            "imei": "string",
            "serial_number": "string"
          }
        ]
      }
    }
  },
  "tpv_response": {
    "amount": "string",
    "card_number": "000000******0000",
    "expiry_date": "0121",
    "transaction_id": "1563B44RPR2",
    "reference_id": "string",
    "platform": "PAYMENTS",
    "payment_link": "string",
    "tax": 21
  }
}
Name Type Required Description
client AddLineToBundleClient false none
sales_info SalesInfo false none
account AddLineToBundleAccount true none
tpv_response SignupsTpvResponse false none

Request 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
 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
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189

curl -X POST https://customers.sta.masstack.com/v2/orgs/telco/signups/subscriptions \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY" \
 --data-raw "{
  'client': {
    'attributes': {
      'document_expiration_date': '1999-01-31',
      'employment': {
        'activity_country_code': 'st',
        'company': 'string',
        'income': 9999999999999.99,
        'income_source': {
          'id': 999999999,
          'observations': 'string'
        },
        'profession': 999999999,
        'professional_area': 999999999,
        'professional_use': true
      }
    }
  },
  'sales_info': {
    'channel': 'dealer',
    'dealer_id': 'string',
    'shop_id': 'string',
    'agent_id': 'string',
    'logistic': true,
    'signature_process_id': 0,
    'signature_type': 'PAPER',
    'channel_id': 0
  },
  'account': {
    'account_id': 0,
    'subscriptions': {
      'mobile_lines': [
        {
          'type': 'additional',
          'product_id': 0,
          'msisdn': 12345,
          'iccid': '8934042419120320845',
          'fabrication_type_sim_id': 214748364,
          'portability_info': {
            'iccid': '8934042419120320845',
            'operator_id': 214748364,
            'operation_type': 1,
            'initial_date_operation': '1999-01-31',
            'donor_line_type': 'C',
            'internal_portability': true,
            'installation_required': true,
            'donor_user': {
              'type': 'existing',
              'document_type_id': 1,
              'document_value': '11111111A'
            }
          },
          'bonuses': [
            {
              'id': 0
            }
          ],
          'promotions': [
            {
              'id': 0,
              'value': 'string'
            }
          ],
          'terminals': [
            {
              'id': 0,
              'financed': true,
              'imei': 'string',
              'serial_number': 'string'
            }
          ],
          'devices': [
            {
              'device_details': {
                'id': 0,
                'model_id': 'string',
                'cession_price': 999999999.99,
                'imei': 'string',
                'pending_imei': true,
                'insured_amount': 0.01,
                'category': 'string',
                'logistic_required': true,
                'catalogue_id': 'string',
                'amount': 0.01
              },
              'fees': {
                'upfront_fee': 999999999.99,
                'installment_plan': {
                  'commission': 999999999.99,
                  'tae': 999999999.99,
                  'tin': 999999999.99,
                  'duration': 1,
                  'monthly_fee': 999999999.99,
                  'last_installment_fee': 999999999.99,
                  'discount_final_payment_value': 999999999.99,
                  'is_promotional_renew': true
                }
              },
              'financial_details': {
                'pre_booking': {
                  'order_id': 'string',
                  'authorization_id': 'string',
                  'financial_entity': 'string',
                  'status': 'Accepted',
                  'granted_amount': 999999999,
                  'credit_line_amount': 999999999,
                  'total_client_financed_value': 999999999.99
                },
                'consents': {
                  'commercial': true,
                  'gdpr': true
                }
              },
              'campaign_id': 0,
              'terms': {
                'penalty_value': 999999999.99,
                'commitment_duration': 9999
              },
              'reservation_id': 0,
              'signature_process_id': 0,
              'signature_type': 'PAPER',
              'old_subscription_terminal_id': 0
            }
          ],
          'expedition_info': {
            'language_id': 214748364,
            'nationality_id': 214748364,
            'name': 'John',
            'middlename': 'Nicholas',
            'lastname': 'Doe',
            'document_type_id': 1,
            'document_value': '11111111A',
            'email': 'john.doe@example.com',
            'birthdate': '1999-01-31',
            'contact_phone': 'string',
            'gender': 'M',
            'address': {
              'street_name': 'string',
              'state_id': 0,
              'locality': 'string',
              'postal_code': 'string',
              'country': 'string',
              'number': 'string',
              'value': 'Castellano'
            },
            'delivery_shop_id': '0025',
            'delivery_type': 'LOGISTIC'
          }
        }
      ],
      'tv': {
        'product_id': 0,
        'number_associated': 12345,
        'registration_email': 'string',
        'contact_phone': 12345,
        'promotions': [
          {
            'id': 0,
            'value': 'string'
          }
        ],
        'terminals': [
          {
            'id': 0,
            'financed': true,
            'imei': 'string',
            'serial_number': 'string'
          }
        ]
      }
    }
  },
  'tpv_response': {
    'amount': 'string',
    'card_number': '000000******0000',
    'expiry_date': '0121',
    'transaction_id': '1563B44RPR2',
    'reference_id': 'string',
    'platform': 'PAYMENTS',
    'payment_link': 'string',
    'tax': 21
  }
}" 

Responses

Code Meaning Description Schema
200 OK Add line to bundle ok AddLineToBundleResponse
202 Accepted Check the risk decision AddLineToBundleResponse
400 Bad Request Invalid request body ErrorMessage

Endpoints

Signups

    Users

      Accounts

        Invoices

          Terms

            Payment info

              Account migrations

                Subscriptions

                  Products

                    Services

                      Bonuses

                        Promotions

                          Barrings

                            Consumption

                              Workorders

                                Penalties