API Overview Resources Schemas

Schemas

ListIdentificationProcessesResponse

1
2
3
4
5
6
7
8


{
  "processes": [
    {
      "process_id": "4189285b-08f8-4628-adda-4767d81362e7",
      "process_date": "2023-01-27T03:44:52.000Z"
    }
  ]
}

Name	Type	Required	Description
processes	[IdentificationProcessSummaryResponse]	true	none

GetIdentificationProcessResponse

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


{
  "process_id": "4189285b-08f8-4628-adda-4767d81362e7",
  "process_date": "2023-01-27T03:44:52.000Z",
  "document": {
    "url_expiration_date": "2023-01-27T03:44:52.000Z",
    "public_url": "https://storage.googleapis.com/mas-documents-prod/cbd2e693-d71a-4cee-8313-1972acc0394d",
    "media_type": "application/pdf",
    "name": "my_id_document.pdf",
    "type": "NIF",
    "size_bytes": 123456
  }
}

Name	Type	Required	Description
anonymous	IdentificationProcessSummaryResponse	false	none

Name	Type	Required	Description
anonymous	object	false	none
» document	DocumentResponse	false	none

IdentificationProcessSummaryResponse

1
2
3
4


{
  "process_id": "4189285b-08f8-4628-adda-4767d81362e7",
  "process_date": "2023-01-27T03:44:52.000Z"
}

Name	Type	Required	Description
process_id	string(uuid)	true	Identification process id
process_date	string(date-time)	true	Date of the identification process. Format according to ISO 8601

DocumentResponse

1
2
3
4
5
6
7
8


{
  "url_expiration_date": "2023-01-27T03:44:52.000Z",
  "public_url": "https://storage.googleapis.com/mas-documents-prod/cbd2e693-d71a-4cee-8313-1972acc0394d",
  "media_type": "application/pdf",
  "name": "my_id_document.pdf",
  "type": "NIF",
  "size_bytes": 123456
}

Name	Type	Required	Description
url_expiration_date	string(date-time)	true	Expiration date for the supplied link. Format according to ISO 8601
public_url	string	true	Link to download the contract
media_type	string	true	Format of the document to be stored. It must match the format of the binary document Allowed values: pdf, jpeg, jpg, png
name	string	true	Name of the document (without spaces)
type	string	true	Type of contract
size_bytes	integer	true	Size of the document in bytes

AccountCreated

1
2
3
4


{
  "id": "123e4567-e89b-12d3-a456-556642440000",
  "external_id": "214748364"
}

Name	Type	Required	Description
id	string(uuid)	true	Account id
external_id	string¦null	false	Account external id

BillingAddress

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "address_lines": [
    "Avenida de Bruselas, 38"
  ],
  "postal_code": "28108",
  "state_id": "28",
  "locality": "Alcobendas",
  "administrative_area": "Madrid",
  "region_code": "ES"
}

Name	Type	Required	Description
address_lines	[string]	true	none
postal_code	string	true	none
state_id	string	false	none
locality	string	true	none
administrative_area	string	true	none
region_code	string	true	none

GetAccount

 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


{
  "id": "123e4567-e89b-12d3-a456-556642440000",
  "external_id": "214748364",
  "customer_id": "1efd6af5-dc6b-438e-b523-44f91322beac",
  "contract_reference": "MMC1708177227910",
  "modality": "PREPAID",
  "billing_address": {
    "address_lines": [
      "Avenida de Bruselas, 38"
    ],
    "postal_code": "28108",
    "state_id": "28",
    "locality": "Alcobendas",
    "administrative_area": "Madrid",
    "region_code": "ES"
  },
  "payment_method": {
    "direct_debit": {
      "type": "DIRECT_DEBIT",
      "details": {
        "iban": "ES7921000813610123456789"
      }
    },
    "credit_card": {
      "type": "CREDIT_CARD",
      "details": {
        "token_id": "e58ed763-928c-4155-bee9-fdbaaadc15f3"
      }
    },
    "bank_transfer": {
      "type": "BANK_TRANSFER",
      "details": {}
    },
    "teci": {
      "type": "TECI",
      "details": {
        "token_teci": "e58ed763-928c-4155-bee9-fdbaaadc15f3"
      }
    }
  },
  "invoice": {
    "cycle": {
      "name": "DIA 1 - MENSUAL",
      "day": 1,
      "type": "M",
      "frequency": 1
    }
  },
  "created_at": "2022-01-01T01:01:01Z",
  "ended_at": "2022-01-01T01:01:01Z",
  "updated_at": "2022-01-01T01:01:01Z"
}

Name	Type	Required	Description
id	string(uuid)	true	Account id
external_id	string¦null	false	Account external id
customer_id	string(uuid)	true	Customer id
contract_reference	string¦null	false	Contract reference
modality	string	true	none
billing_address	BillingAddress	false	none
payment_method	GetPaymentMethod	true	none
invoice	AccountInvoice	false	Account invoice info
created_at	string(date-time)	true	Account creation date
ended_at	string(date-time)¦null	false	Account end date
updated_at	string(date-time)	true	Account end date

Property	Values
modality	one of [PREPAID, RECURRING_PREPAID, POSTPAID]

AccountInvoice

1
2
3
4
5
6
7
8


{
  "cycle": {
    "name": "DIA 1 - MENSUAL",
    "day": 1,
    "type": "M",
    "frequency": 1
  }
}

Name	Type	Required	Description
cycle	InvoiceCycle	false	Invoice cycle info

InvoiceCycle

1
2
3
4
5
6


{
  "name": "DIA 1 - MENSUAL",
  "day": 1,
  "type": "M",
  "frequency": 1
}

Name	Type	Required	Description
name	string	false	Invoice cycle name
day	integer(int32)	false	Invoice cycle day
type	string	false	Invoice cycle type (‘M’ for monthly…etc)
frequency	integer(int32)	false	Invoice cycle frequency (once a month, twice a year…etc)

PaymentType

1

"BANK_TRANSFER"

Name	Type	Required	Description
anonymous	string	false	none

Property	Values
anonymous	one of [BANK_TRANSFER, DIRECT_DEBIT, CREDIT_CARD]

GetPaymentType

1

"BANK_TRANSFER"

Name	Type	Required	Description
anonymous	string	false	none

Property	Values
anonymous	one of [BANK_TRANSFER, DIRECT_DEBIT, CREDIT_CARD, TECI]

PatchPaymentType

1

"BANK_TRANSFER"

Name	Type	Required	Description
anonymous	string	false	none

Property	Values
anonymous	one of [BANK_TRANSFER, DIRECT_DEBIT, CREDIT_CARD]

AvailablePaymentMethods

1
2
3
4
5


{
  "payment_methods": [
    "BANK_TRANSFER"
  ]
}

Name	Type	Required	Description
payment_methods	[AvailablePaymentMethod]	false	none

AvailablePaymentMethod

1

"BANK_TRANSFER"

Name	Type	Required	Description
anonymous	string	false	none

Property	Values
anonymous	one of [BANK_TRANSFER, DIRECT_DEBIT, CREDIT_CARD, TECI]

PaymentMethod

1
2
3
4
5
6


{
  "type": "BANK_TRANSFER",
  "details": {
    "iban": "ES7921000813610123456789"
  }
}

Name	Type	Required	Description
type	PaymentType	true	none
details	object¦null	false	iban is mandatory when type is DIRECT_DEBIT, token_id is mandatory when type is CREDIT_CARD

Name	Type	Required	Description
» anonymous	object	false	none
»» iban	string	true	Only for direct debit payment method

Name	Type	Required	Description
» anonymous	object	false	none
»» token_id	string(uuid)	true	Only for credit card payment method, this value is the token id of the tokenized credit card

PatchAccountPaymentMethod

1
2
3
4
5
6


{
  "type": "BANK_TRANSFER",
  "details": {
    "iban": "ES7921000813610123456789"
  }
}

Name	Type	Required	Description
type	PatchPaymentType	true	none
details	object¦null	false	iban is mandatory when type is DIRECT_DEBIT, token_id is mandatory when type is CREDIT_CARD

Name	Type	Required	Description
» anonymous	object	false	none
»» iban	string	true	Only for direct debit payment method

Name	Type	Required	Description
» anonymous	object	false	none
»» token_id	string(uuid)	true	Only for credit card payment method, this value is the id of the tokenized credit card

GetPaymentMethod

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


{
  "direct_debit": {
    "type": "DIRECT_DEBIT",
    "details": {
      "iban": "ES7921000813610123456789"
    }
  },
  "credit_card": {
    "type": "CREDIT_CARD",
    "details": {
      "token_id": "e58ed763-928c-4155-bee9-fdbaaadc15f3"
    }
  },
  "bank_transfer": {
    "type": "BANK_TRANSFER",
    "details": {}
  },
  "teci": {
    "type": "TECI",
    "details": {
      "token_teci": "e58ed763-928c-4155-bee9-fdbaaadc15f3"
    }
  }
}

Name	Type	Required	Description
type	GetPaymentType	true	none
details	object¦null	false	iban is mandatory when type is DIRECT_DEBIT, credit_card is mandatory when type is CREDIT_CARD, token-teci is mandatory when type is TECI

Name	Type	Required	Description
» anonymous	GetDirectDebitPaymentMethodDetails	false	none

Name	Type	Required	Description
» anonymous	GetCreditCardPaymentMethodDetails	false	none

Name	Type	Required	Description
» anonymous	GetTeciPaymentMethodDetails	false	none

GetDirectDebitPaymentMethodDetails

1
2
3


{
  "iban": "ES7921000813610123456789"
}

Name	Type	Required	Description
iban	string	true	Only for direct debit payment method

GetCreditCardPaymentMethodDetails

1
2
3
4
5


{
  "id": "e58ed763-928c-4155-bee9-fdbaaadc15f3",
  "summary": "5100",
  "expiration_date": "05/2029"
}

Name	Type	Required	Description
id	string(uuid)	true	Credit card id. Only for credit card payment method
summary	string	true	Masked credit card number. Only for credit card payment method
expiration_date	string	true	Credit card expiration date (MM/yyyy format). Only for credit card payment method

GetTeciPaymentMethodDetails

1
2
3


{
  "token-teci": "Ob1dI04xvw-k25HBs3a4SHqTkkRWxKAnbFVcX1QzAfk"
}

Name	Type	Required	Description
token-teci	string	true	Only for TECI payment method

CustomerTokenizedCreditCards

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "available_credit_cards": [
    {
      "id": "e58ed763-928c-4155-bee9-fdbaaadc15f3",
      "created_at": "2022-01-01T01:01:01Z",
      "summary": "5100",
      "expiration_date": "05/2029"
    }
  ]
}

Name	Type	Required	Description
available_credit_cards	[CustomerTokenizedCreditCard]	false	none

CustomerTokenizedCreditCard

1
2
3
4
5
6


{
  "id": "e58ed763-928c-4155-bee9-fdbaaadc15f3",
  "created_at": "2022-01-01T01:01:01Z",
  "summary": "5100",
  "expiration_date": "05/2029"
}

Name	Type	Required	Description
id	string(uuid)	false	Credit card id
created_at	string(date-time)	false	Credit card creation date
summary	string	false	Masked credit card number
expiration_date	string	false	Credit card expiration date (MM/yyyy format)

PostAccount

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


{
  "modality": "RECURRING_PREPAID",
  "billing_address": {
    "address_lines": [
      "Avenida de Bruselas, 38"
    ],
    "postal_code": "28108",
    "state_id": "28",
    "locality": "Alcobendas",
    "administrative_area": "Madrid",
    "region_code": "ES"
  },
  "payment_method": {
    "type": "BANK_TRANSFER",
    "details": {
      "iban": "ES7921000813610123456789"
    }
  }
}

Name	Type	Required	Description
modality	string	true	none
billing_address	BillingAddress	false	none
payment_method	PaymentMethod	true	none

Property	Values
modality	one of [RECURRING_PREPAID, POSTPAID]

AccountIds

1
2
3
4
5
6
7


{
  "accounts": [
    {
      "id": "123e4567-e89b-12d3-a456-556642440000"
    }
  ]
}

Name	Type	Required	Description
accounts	[AccountId]	false	none

AccountId

1
2
3


{
  "id": "123e4567-e89b-12d3-a456-556642440000"
}

Name	Type	Required	Description
id	string(uuid)	false	Account id

CustomerSearchResponse

1
2
3
4
5


{
  "customer": {
    "id": "123e4567-e89b-12d3-a456-556642440000"
  }
}

Name	Type	Required	Description
customer	object	false	none
» id	string(uuid)	false	Customer’s identifier

CustomerResponseCommonProperties

 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


{
  "id": "123e4567-e89b-12d3-a456-556642440000",
  "external_id": "214748364",
  "created_at": "2022-01-01T01:01:01Z",
  "ended_at": "2022-01-01T01:01:01Z",
  "updated_at": "2022-01-01T01:01:01Z",
  "type": "PRIVATE_CUSTOMER",
  "preferred_language": "es",
  "segment": "CONSUMER",
  "contact_info": {
    "phone_numbers": [
      {
        "country_code": "+34",
        "number": "615667898",
        "type": "MOBILE"
      }
    ],
    "emails": [
      {
        "email": "email@example.com"
      }
    ],
    "addresses": [
      {
        "address_lines": [
          "Calle Mayor 2, 3º A"
        ],
        "postal_code": "28039",
        "locality": "Fuenlabrada",
        "administrative_area": "Madrid",
        "region_code": "ES"
      }
    ]
  }
}

Name	Type	Required	Description
id	string(uuid)	true	Customer’s identifier
external_id	string¦null	false	Customer’s external identifier
created_at	string(date-time)	true	Customer’s creation date
ended_at	string(date-time)¦null	false	Customer’s deactivation date
updated_at	string(date-time)	true	Customer’s last modification date
type	CustomerType	true	none
preferred_language	LanguageCode	true	Customer’s preferred language code in ISO-639-1 lowercase format
segment	Segment	true	Customer’s segment, whether it is an individual, a self-employed customer, or a company (although so far we just support SME - Small Medium Enterprise). For PrivateCustomer: * CONSUMER For CorporateCustomer: * SELF_EMPLOYEE * SME
contact_info	ContactInfoResponse	true	none

CustomerResponse

 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


{
  "id": "123e4567-e89b-12d3-a456-556642440000",
  "external_id": "214748364",
  "created_at": "2022-01-01T01:01:01Z",
  "ended_at": "2022-01-01T01:01:01Z",
  "updated_at": "2022-01-01T01:01:01Z",
  "type": "PRIVATE_CUSTOMER",
  "preferred_language": "es",
  "segment": "CONSUMER",
  "contact_info": {
    "phone_numbers": [
      {
        "country_code": "+34",
        "number": "615667898",
        "type": "MOBILE"
      }
    ],
    "emails": [
      {
        "email": "email@example.com"
      }
    ],
    "addresses": [
      {
        "address_lines": [
          "Calle Mayor 2, 3º A"
        ],
        "postal_code": "28039",
        "locality": "Fuenlabrada",
        "administrative_area": "Madrid",
        "region_code": "ES"
      }
    ]
  },
  "personal_info": {
    "identity_document": {
      "number": "14861628V",
      "type": "NIF"
    },
    "name": "Antonio",
    "first_surname": "Benavente",
    "second_surname": "Blanco",
    "gender": "MALE",
    "nationality": "ES",
    "birthdate": "2022-01-01"
  }
}

Name	Type	Required	Description
anonymous	PrivateCustomerResponse	false	none

Name	Type	Required	Description
anonymous	CorporateCustomerResponse	false	none

Name	Type	Required	Description
anonymous	DigitalCustomerResponse	false	none

DigitalCustomerResponse

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


{
  "id": "123e4567-e89b-12d3-a456-556642440000",
  "created_at": "2022-01-01T01:01:01Z",
  "ended_at": "2022-01-01T01:01:01Z",
  "updated_at": "2022-01-01T01:01:01Z",
  "type": "PRIVATE_CUSTOMER",
  "preferred_language": "es",
  "digital_personal_info": {
    "name": "Jose",
    "first_surname": "Carrero",
    "second_surname": "Diaz",
    "email": "email@example.com",
    "mobile_phone_number": {
      "country_code": "+34",
      "number": "615667898"
    }
  }
}

Name	Type	Required	Description
id	string(uuid)	true	Customer’s identifier
created_at	string(date-time)	true	Customer’s creation date
ended_at	string(date-time)¦null	false	Customer’s deactivation date
updated_at	string(date-time)	true	Customer’s last modification date
type	CustomerType	true	none
preferred_language	LanguageCode	true	Customer’s preferred language code in ISO-639-1 lowercase format
digital_personal_info	DigitalPersonalInfoResponse	true	Digital customer personal information

PrivateCustomerResponse

 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


{
  "id": "123e4567-e89b-12d3-a456-556642440000",
  "external_id": "214748364",
  "created_at": "2022-01-01T01:01:01Z",
  "ended_at": "2022-01-01T01:01:01Z",
  "updated_at": "2022-01-01T01:01:01Z",
  "type": "PRIVATE_CUSTOMER",
  "preferred_language": "es",
  "segment": "CONSUMER",
  "contact_info": {
    "phone_numbers": [
      {
        "country_code": "+34",
        "number": "615667898",
        "type": "MOBILE"
      }
    ],
    "emails": [
      {
        "email": "email@example.com"
      }
    ],
    "addresses": [
      {
        "address_lines": [
          "Calle Mayor 2, 3º A"
        ],
        "postal_code": "28039",
        "locality": "Fuenlabrada",
        "administrative_area": "Madrid",
        "region_code": "ES"
      }
    ]
  },
  "personal_info": {
    "identity_document": {
      "number": "14861628V",
      "type": "NIF"
    },
    "name": "Antonio",
    "first_surname": "Benavente",
    "second_surname": "Blanco",
    "gender": "MALE",
    "nationality": "ES",
    "birthdate": "2022-01-01"
  }
}

Name	Type	Required	Description
anonymous	CustomerResponseCommonProperties	false	none

Name	Type	Required	Description
anonymous	object	false	none
» personal_info	PersonalInfoResponse	false	Private customer personal information

CorporateCustomerResponse

 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


{
  "id": "123e4567-e89b-12d3-a456-556642440000",
  "external_id": "214748364",
  "created_at": "2022-01-01T01:01:01Z",
  "ended_at": "2022-01-01T01:01:01Z",
  "updated_at": "2022-01-01T01:01:01Z",
  "type": "PRIVATE_CUSTOMER",
  "preferred_language": "es",
  "segment": "CONSUMER",
  "contact_info": {
    "phone_numbers": [
      {
        "country_code": "+34",
        "number": "615667898",
        "type": "MOBILE"
      }
    ],
    "emails": [
      {
        "email": "email@example.com"
      }
    ],
    "addresses": [
      {
        "address_lines": [
          "Calle Mayor 2, 3º A"
        ],
        "postal_code": "28039",
        "locality": "Fuenlabrada",
        "administrative_area": "Madrid",
        "region_code": "ES"
      }
    ]
  },
  "company_info": {
    "identity_document": {
      "number": "B14507610",
      "type": "CIF"
    },
    "legal_name": "IBM Inc",
    "founding_date": "2022-01-01",
    "associated_users": [
      {
        "identity_document": {
          "number": "14861628V",
          "type": "NIF"
        },
        "role": "AUTHORIZED_REPRESENTATIVE",
        "name": "Antonio",
        "first_surname": "Benavente",
        "second_surname": "Blanco",
        "nationality": "ES"
      }
    ]
  }
}

Name	Type	Required	Description
anonymous	CustomerResponseCommonProperties	false	none

Name	Type	Required	Description
anonymous	object	false	none
» company_info	CompanyInfoResponse	false	none

PersonalInfoName

1

"Antonio"

Name	Type	Required	Description
anonymous	string	false	Customer’s first name (including middle name if applicable)

PersonalInfoFirstSurname

1

"Benavente"

Name	Type	Required	Description
anonymous	string	false	Customer’s first surname

PersonalInfoSecondSurname

1

"Blanco"

Name	Type	Required	Description
anonymous	string¦null	false	Consumer’s rest of surnames

PersonalInfoBirthdate

1

"2022-01-01"

Name	Type	Required	Description
anonymous	string(date)	false	Customer’s date of birth

PersonalInfo

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


{
  "identity_document": {
    "number": "14861628V",
    "type": "NIF"
  },
  "name": "Antonio",
  "first_surname": "Benavente",
  "second_surname": "Blanco",
  "gender": "MALE",
  "nationality": "ES",
  "birthdate": "2022-01-01"
}

Name	Type	Required	Description
identity_document	PersonalIdentityDocument	true	Private customer identification document
name	PersonalInfoName	true	Customer’s first name (including middle name if applicable)
first_surname	PersonalInfoFirstSurname	true	Customer’s first surname
second_surname	PersonalInfoSecondSurname	false	Consumer’s rest of surnames
gender	string	false	Customer’s gender
nationality	string	true	Customer’s nationality code in ISO 3166-1 alpha-2 uppercase format. ‘ZZ’ is used for unknown countries.
birthdate	PersonalInfoBirthdate	true	Customer’s date of birth

Property	Values
gender	one of [MALE, FEMALE, UNSPECIFIED]

PatchPersonalInfo

1
2
3
4
5
6


{
  "name": "Antonio",
  "first_surname": "Benavente",
  "second_surname": "Blanco",
  "birthdate": "2022-01-01"
}

Name	Type	Required	Description
name	PersonalInfoName	false	Customer’s first name (including middle name if applicable)
first_surname	PersonalInfoFirstSurname	false	Customer’s first surname
second_surname	PersonalInfoSecondSurname	false	Consumer’s rest of surnames
birthdate	PersonalInfoBirthdate	false	Customer’s date of birth

CompanyInfoLegalName

1

"IBM Inc"

Name	Type	Required	Description
anonymous	string	false	Company’s legal name

CompanyInfoFoundingDate

1

"2022-01-01"

Name	Type	Required	Description
anonymous	string(date)	false	Company’s foundation date

PatchDigitalPersonalInfo

1
2
3
4
5
6
7
8
9


{
  "name": "Jose",
  "first_surname": "Carrero",
  "second_surname": "Diaz",
  "mobile_phone_number": {
    "country_code": "+34",
    "number": "615667898"
  }
}

Name	Type	Required	Description
name	DigitalPersonalInfoName	false	Customer’s first name
first_surname	DigitalPersonalInfoFirstSurname	false	Customer’s first surname
second_surname	DigitalPersonalInfoSecondSurname	false	Consumer’s rest of surnames
mobile_phone_number	MobilePhoneNumber	false	none

DigitalPersonalInfoResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "name": "Jose",
  "first_surname": "Carrero",
  "second_surname": "Diaz",
  "email": "email@example.com",
  "mobile_phone_number": {
    "country_code": "+34",
    "number": "615667898"
  }
}

Name	Type	Required	Description
name	DigitalPersonalInfoName	false	Customer’s first name
first_surname	DigitalPersonalInfoFirstSurname	false	Customer’s first surname
second_surname	DigitalPersonalInfoSecondSurname	false	Consumer’s rest of surnames
email	DigitalEmail	false	Case insensitive customer’s email, no accent marks allowed
mobile_phone_number	MobilePhoneNumber	false	none

PersonalInfoResponse

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


{
  "identity_document": {
    "number": "14861628V",
    "type": "NIF"
  },
  "name": "Antonio",
  "first_surname": "Benavente",
  "second_surname": "Blanco",
  "gender": "MALE",
  "nationality": "ES",
  "birthdate": "2022-01-01"
}

Name	Type	Required	Description
identity_document	PersonalIdentityDocument	false	Private customer identification document
name	string	false	Customer’s first name (including middle name if applicable)
first_surname	string¦null	false	Customer’s first surname
second_surname	string¦null	false	Consumer’s rest of surnames
gender	string¦null	false	Customer’s gender
nationality	string¦null	false	Customer’s nationality code in ISO 3166-1 alpha-2 uppercase format. ‘ZZ’ is used for unknown countries.
birthdate	string(date)¦null	false	Customer’s date of birth

Property	Values
gender	one of [MALE, FEMALE, UNSPECIFIED]

CompanyInfo

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


{
  "identity_document": {
    "number": "B14507610",
    "type": "CIF"
  },
  "legal_name": "IBM Inc",
  "founding_date": "2022-01-01",
  "associated_users": [
    {
      "identity_document": {
        "number": "14861628V",
        "type": "NIF"
      },
      "role": "AUTHORIZED_REPRESENTATIVE",
      "name": "Antonio",
      "first_surname": "Benavente",
      "second_surname": "Blanco",
      "nationality": "ES"
    }
  ]
}

Name	Type	Required	Description
identity_document	CorporateIdentityDocument	true	Corporate customer identification document
legal_name	CompanyInfoLegalName	true	Company’s legal name
founding_date	CompanyInfoFoundingDate	true	Company’s foundation date
associated_users	[AssociatedUser]	true	[Business Customer associated user]

CompanyInfoResponse

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


{
  "identity_document": {
    "number": "B14507610",
    "type": "CIF"
  },
  "legal_name": "IBM Inc",
  "founding_date": "2022-01-01",
  "associated_users": [
    {
      "identity_document": {
        "number": "14861628V",
        "type": "NIF"
      },
      "role": "AUTHORIZED_REPRESENTATIVE",
      "name": "Antonio",
      "first_surname": "Benavente",
      "second_surname": "Blanco",
      "nationality": "ES"
    }
  ]
}

Name	Type	Required	Description
identity_document	CorporateIdentityDocument	false	Corporate customer identification document
legal_name	string	false	Company’s legal name
founding_date	string(date)¦null	false	Company’s foundation date
associated_users	[AssociatedUser]	false	[Business Customer associated user]

PatchCompanyInfo

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


{
  "legal_name": "IBM Inc",
  "founding_date": "2022-01-01",
  "associated_users": [
    {
      "identity_document": {
        "number": "14861628V",
        "type": "NIF"
      }
    }
  ]
}

Name	Type	Required	Description
legal_name	CompanyInfoLegalName	false	Company’s legal name
founding_date	CompanyInfoFoundingDate	false	Company’s foundation date
associated_users	[PatchAssociatedUser]	false	[Update Business Customer associated user]

AssociatedUser

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "identity_document": {
    "number": "14861628V",
    "type": "NIF"
  },
  "role": "AUTHORIZED_REPRESENTATIVE",
  "name": "Antonio",
  "first_surname": "Benavente",
  "second_surname": "Blanco",
  "nationality": "ES"
}

Name	Type	Required	Description
identity_document	PersonalIdentityDocument	true	Private customer identification document
role	string	false	The role of the user in the relationship between their company and us
name	string	true	Associated user’s first name (including middle name if applicable)
first_surname	string	true	Associated user’s first surname
second_surname	string¦null	false	Associated user’s rest of surnames
nationality	string	true	Associated user’s nationality code in ISO 3166-1 alpha-2 uppercase format. ‘ZZ’ is used for unknown countries.

Property	Values
role	one of [AUTHORIZED_REPRESENTATIVE]

PatchAssociatedUser

1
2
3
4
5
6


{
  "identity_document": {
    "number": "14861628V",
    "type": "NIF"
  }
}

Name	Type	Required	Description
identity_document	PersonalIdentityDocument	true	Private customer identification document

LanguageCode

1

"es"

Name	Type	Required	Description
anonymous	string	false	Customer’s preferred language code in ISO-639-1 lowercase format

Property	Values
anonymous	one of [es, ca, gl, eu, en, pt]

Segment

1

"CONSUMER"

Name	Type	Required	Description
anonymous	string	false	Customer’s segment, whether it is an individual, a self-employed customer, or a company (although so far we just support SME - Small Medium Enterprise). For PrivateCustomer: * CONSUMER For CorporateCustomer: * SELF_EMPLOYEE * SME

Property	Values
anonymous	one of [CONSUMER, SELF_EMPLOYEE, SME]

PatchPhoneNumberArray

1
2
3
4
5
6
7


[
  {
    "country_code": "+34",
    "number": "615667898",
    "type": "MOBILE"
  }
]

Name	Type	Required	Description
anonymous	[PatchPhoneNumber]	false	List of phone numbers that the customer can be contacted with. At least one phone number is required

ContactInfoPhoneNumbers

1
2
3
4
5
6
7
8


[
  {
    "country_code": "+34",
    "number": "615667898",
    "type": "MOBILE",
    "is_default": true
  }
]

Name	Type	Required	Description
anonymous	[PhoneNumber]	false	List of phone numbers that the customer can be contacted with. At least one default phone number is required

PatchEmailArray

1
2
3
4
5


[
  {
    "email": "email@example.com"
  }
]

Name	Type	Required	Description
anonymous	[PatchEmail]	false	List of emails that the customer can be contacted with. At least one email is required

ContactInfoEmails

1
2
3
4
5
6


[
  {
    "email": "email@example.com",
    "is_default": true
  }
]

Name	Type	Required	Description
anonymous	[Email]	false	List of emails that the customer can be contacted with. At least one default email is required

PatchContactInfo

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


{
  "phone_numbers": [
    {
      "country_code": "+34",
      "number": "615667898",
      "type": "MOBILE"
    }
  ],
  "emails": [
    {
      "email": "email@example.com"
    }
  ]
}

Name	Type	Required	Description
phone_numbers	PatchPhoneNumberArray	false	List of phone numbers that the customer can be contacted with. At least one phone number is required
emails	PatchEmailArray	false	List of emails that the customer can be contacted with. At least one email is required

ContactInfo

 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


{
  "phone_numbers": [
    {
      "country_code": "+34",
      "number": "615667898",
      "type": "MOBILE",
      "is_default": true
    }
  ],
  "emails": [
    {
      "email": "email@example.com",
      "is_default": true
    }
  ],
  "postal_address": {
    "address_lines": [
      "Calle Mayor 2, 3º A"
    ],
    "postal_code": "28039",
    "locality": "Fuenlabrada",
    "administrative_area": "Madrid",
    "region_code": "ES"
  }
}

Name	Type	Required	Description
phone_numbers	ContactInfoPhoneNumbers	true	List of phone numbers that the customer can be contacted with. At least one default phone number is required
emails	ContactInfoEmails	true	List of emails that the customer can be contacted with. At least one default email is required
postal_address	Address	true	Postal address of the customer or user

ContactInfoResponse

 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


{
  "phone_numbers": [
    {
      "country_code": "+34",
      "number": "615667898",
      "type": "MOBILE"
    }
  ],
  "emails": [
    {
      "email": "email@example.com"
    }
  ],
  "addresses": [
    {
      "address_lines": [
        "Calle Mayor 2, 3º A"
      ],
      "postal_code": "28039",
      "locality": "Fuenlabrada",
      "administrative_area": "Madrid",
      "region_code": "ES"
    }
  ]
}

Name	Type	Required	Description
phone_numbers	[PhoneNumberResponse]	true	List of 0 to 1 phone numbers that the customer can be contacted with.
emails	[EmailResponse]	true	List of 0 to 1 emails that the customer can be contacted with.
addresses	[Address]	true	List of 0 or more postal addresses that the customer can be contacted with.

PatchEmail

1
2
3


{
  "email": "email@example.com"
}

Name	Type	Required	Description
email	string	true	Case insensitive customer’s email, no accent marks allowed

Email

1
2
3
4


{
  "email": "email@example.com",
  "is_default": true
}

Name	Type	Required	Description
email	string	true	Case insensitive customer’s email, no accent marks allowed
is_default	boolean	false	If the payload contains ony one email, this boolean value is ignored, and this email is set as the default one. If the payload contains more than one email, only one of them can be set as the default one.

EmailResponse

1
2
3


{
  "email": "email@example.com"
}

Name	Type	Required	Description
email	string	false	Case insensitive customer’s email, no accent marks allowed

Address

1
2
3
4
5
6
7
8
9


{
  "address_lines": [
    "Calle Mayor 2, 3º A"
  ],
  "postal_code": "28039",
  "locality": "Fuenlabrada",
  "administrative_area": "Madrid",
  "region_code": "ES"
}

Name	Type	Required	Description
address_lines	[string]	true	The full address, including the floor, door, and other supplements.
postal_code	string	true	Address postal code, which identifies the subdivision within a locality where the address is located.
locality	string	true	Name of the city, town, or similar where the address is located.
administrative_area	string¦null	true	Name of the state, province, or similar where the address is located.
region_code	string	true	Region or country code in ISO 3166-1 alpha-2 uppercase format. ‘ZZ’ is used for unknown countries.

PhoneNumberType

1

"MOBILE"

Name	Type	Required	Description
anonymous	string	false	Phone number type, which determines if it can receive SMS or not

Property	Values
anonymous	one of [MOBILE]

PatchPhoneNumber

1
2
3
4
5


{
  "country_code": "+34",
  "number": "615667898",
  "type": "MOBILE"
}

Name	Type	Required	Description
country_code	string	true	Phone number country code according to the ITU (optionally preceded with a ‘+')
number	string	true	Phone number value
type	PhoneNumberType	true	Phone number type, which determines if it can receive SMS or not

PhoneNumber

1
2
3
4
5
6


{
  "country_code": "+34",
  "number": "615667898",
  "type": "MOBILE",
  "is_default": true
}

Name	Type	Required	Description
country_code	string	true	Phone number country code according to the ITU (optionally preceded with a ‘+')
number	string	true	Phone number value
type	PhoneNumberType	true	Phone number type, which determines if it can receive SMS or not
is_default	boolean	false	If the payload contains ony one phone number, this boolean value is ignored, and this phone number is set as the default one. If the payload contains more than one phone number, only one of them can be set as the default one.

PhoneNumberResponse

1
2
3
4
5


{
  "country_code": "+34",
  "number": "615667898",
  "type": "MOBILE"
}

Name	Type	Required	Description
country_code	string	false	Phone number country code according to the ITU (optionally preceded with a ‘+')
number	string	false	Phone number value
type	string	false	Phone number type, which determines if it can receive SMS or not

Property	Values
type	one of [MOBILE, LANDLINE]

PersonalIdentityDocument

1
2
3
4


{
  "number": "14861628V",
  "type": "NIF"
}

Name	Type	Required	Description
number	string	true	Alphanumeric part of the Identification Document
type	string	true	Identification Document type

Property	Values
type	one of [NIF, NIE, PASSPORT]

CorporateIdentityDocument

1
2
3
4


{
  "number": "B14507610",
  "type": "CIF"
}

Name	Type	Required	Description
number	string	true	Alphanumeric part of the Identification Document
type	string	true	Identification Document type

Property	Values
type	one of [CIF]

CustomerType

1

"PRIVATE_CUSTOMER"

Name	Type	Required	Description
anonymous	string	false	none

Property	Values
anonymous	one of [PRIVATE_CUSTOMER, CORPORATE_CUSTOMER, DIGITAL_CUSTOMER]

NewPrivateCustomer

 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


{
  "type": "PRIVATE_CUSTOMER",
  "preferred_language": "es",
  "segment": "CONSUMER",
  "contact_info": {
    "phone_numbers": [
      {
        "country_code": "+34",
        "number": "615667898",
        "type": "MOBILE",
        "is_default": true
      }
    ],
    "emails": [
      {
        "email": "email@example.com",
        "is_default": true
      }
    ],
    "postal_address": {
      "address_lines": [
        "Calle Mayor 2, 3º A"
      ],
      "postal_code": "28039",
      "locality": "Fuenlabrada",
      "administrative_area": "Madrid",
      "region_code": "ES"
    }
  },
  "personal_info": {
    "identity_document": {
      "number": "14861628V",
      "type": "NIF"
    },
    "name": "Antonio",
    "first_surname": "Benavente",
    "second_surname": "Blanco",
    "gender": "MALE",
    "nationality": "ES",
    "birthdate": "2022-01-01"
  }
}

Name	Type	Required	Description
type	CustomerType	true	none
preferred_language	LanguageCode	true	Customer’s preferred language code in ISO-639-1 lowercase format
segment	Segment	true	Customer’s segment, whether it is an individual, a self-employed customer, or a company (although so far we just support SME - Small Medium Enterprise). For PrivateCustomer: * CONSUMER For CorporateCustomer: * SELF_EMPLOYEE * SME
contact_info	ContactInfo	true	none
personal_info	PersonalInfo	true	Private customer personal information

NewDigitalCustomer

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


{
  "type": "PRIVATE_CUSTOMER",
  "preferred_language": "es",
  "digital_personal_info": {
    "name": "Jose",
    "first_surname": "Carrero",
    "second_surname": "Diaz",
    "email": "email@example.com",
    "mobile_phone_number": {
      "country_code": "+34",
      "number": "615667898"
    }
  }
}

Name	Type	Required	Description
type	CustomerType	true	none
preferred_language	LanguageCode	true	Customer’s preferred language code in ISO-639-1 lowercase format
digital_personal_info	DigitalPersonalInfo	true	Digital customer personal information

DigitalPersonalInfo

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "name": "Jose",
  "first_surname": "Carrero",
  "second_surname": "Diaz",
  "email": "email@example.com",
  "mobile_phone_number": {
    "country_code": "+34",
    "number": "615667898"
  }
}

Name	Type	Required	Description
name	DigitalPersonalInfoName	false	Customer’s first name
first_surname	DigitalPersonalInfoFirstSurname	false	Customer’s first surname
second_surname	DigitalPersonalInfoSecondSurname	false	Consumer’s rest of surnames
email	DigitalEmail	true	Case insensitive customer’s email, no accent marks allowed
mobile_phone_number	MobilePhoneNumber	false	none

DigitalPersonalInfoName

1

"Jose"

Name	Type	Required	Description
anonymous	string	false	Customer’s first name

DigitalPersonalInfoFirstSurname

1

"Carrero"

Name	Type	Required	Description
anonymous	string	false	Customer’s first surname

DigitalPersonalInfoSecondSurname

1

"Diaz"

Name	Type	Required	Description
anonymous	string¦null	false	Consumer’s rest of surnames

DigitalEmail

1

"email@example.com"

Name	Type	Required	Description
anonymous	string	false	Case insensitive customer’s email, no accent marks allowed

MobilePhoneNumber

1
2
3
4


{
  "country_code": "+34",
  "number": "615667898"
}

Name	Type	Required	Description
country_code	string	true	Phone number country code according to the ITU (optionally preceded with a ‘+')
number	string	true	Mobile Phone number value

PatchCustomerRequest

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


{
  "preferred_language": "es",
  "contact_info": {
    "phone_numbers": [
      {
        "country_code": "+34",
        "number": "615667898",
        "type": "MOBILE"
      }
    ],
    "emails": [
      {
        "email": "email@example.com"
      }
    ]
  },
  "personal_info": {
    "name": "Antonio",
    "first_surname": "Benavente",
    "second_surname": "Blanco",
    "birthdate": "2022-01-01"
  }
}

Name	Type	Required	Description
anonymous	object	false	Information required to update a customer
» preferred_language	LanguageCode	false	Customer’s preferred language code in ISO-639-1 lowercase format
» contact_info	PatchContactInfo	false	none

Name	Type	Required	Description
anonymous	any	false	none

Name	Type	Required	Description
» anonymous	object	false	none
»» personal_info	PatchPersonalInfo	false	Private customer personal information

Name	Type	Required	Description
» anonymous	object	false	none
»» company_info	PatchCompanyInfo	false	Update Company Info

Name	Type	Required	Description
» anonymous	object	false	none
»» digital_personal_info	PatchDigitalPersonalInfo	false	Update Digital Personal Info

NewCorporateCustomer

 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


{
  "type": "PRIVATE_CUSTOMER",
  "preferred_language": "es",
  "segment": "CONSUMER",
  "contact_info": {
    "phone_numbers": [
      {
        "country_code": "+34",
        "number": "615667898",
        "type": "MOBILE",
        "is_default": true
      }
    ],
    "emails": [
      {
        "email": "email@example.com",
        "is_default": true
      }
    ],
    "postal_address": {
      "address_lines": [
        "Calle Mayor 2, 3º A"
      ],
      "postal_code": "28039",
      "locality": "Fuenlabrada",
      "administrative_area": "Madrid",
      "region_code": "ES"
    }
  },
  "company_info": {
    "identity_document": {
      "number": "B14507610",
      "type": "CIF"
    },
    "legal_name": "IBM Inc",
    "founding_date": "2022-01-01",
    "associated_users": [
      {
        "identity_document": {
          "number": "14861628V",
          "type": "NIF"
        },
        "role": "AUTHORIZED_REPRESENTATIVE",
        "name": "Antonio",
        "first_surname": "Benavente",
        "second_surname": "Blanco",
        "nationality": "ES"
      }
    ]
  }
}

Name	Type	Required	Description
type	CustomerType	true	none
preferred_language	LanguageCode	true	Customer’s preferred language code in ISO-639-1 lowercase format
segment	Segment	true	Customer’s segment, whether it is an individual, a self-employed customer, or a company (although so far we just support SME - Small Medium Enterprise). For PrivateCustomer: * CONSUMER For CorporateCustomer: * SELF_EMPLOYEE * SME
contact_info	ContactInfo	true	none
company_info	CompanyInfo	true	none

CredentialCreated

1
2
3


{
  "id": "123e4567-e89b-12d3-a456-556642440000"
}

Name	Type	Required	Description
id	string(uuid)	false	Credential id

CustomerCreated

1
2
3
4


{
  "id": "123e4567-e89b-12d3-a456-556642440000",
  "external_id": "1111"
}

Name	Type	Required	Description
id	string(uuid)	false	Customer id
external_id	string¦null	false	Customer external id. Only returned when inserted by ourselves.

CustomerId

1
2
3


{
  "id": "123e4567-e89b-12d3-a456-556642440000"
}

Name	Type	Required	Description
id	string(uuid)	false	Customer id

Credentials

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "username": "username@masmovil.com",
  "customer_id": "123e4567-e89b-12d3-a456-556642440000",
  "credentials": [
    {
      "id": "0c3c8412-2ac2-4c93-8122-c8afb9141457",
      "username": "username@masmovil.com"
    }
  ]
}

Name	Type	Required	Description
username	string	false	Username
customer_id	string(uuid)	false	Customer id
credentials	[CredentialResponse]	true	[Credential of customer]

Credential

1
2
3


{
  "username": "username@masmovil.com"
}

Name	Type	Required	Description
username	string	true	Username

CredentialResponse

1
2
3
4


{
  "id": "0c3c8412-2ac2-4c93-8122-c8afb9141457",
  "username": "username@masmovil.com"
}

Name	Type	Required	Description
id	string(uuid)	true	Credential id
username	string	true	Username

PostCategories

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "categories": [
    {
      "name": "risk",
      "description": "Risk category",
      "valid_values": [
        "string"
      ]
    }
  ]
}

Name	Type	Required	Description
categories	[PostCategory]	true	none

PostCategory

1
2
3
4
5
6
7


{
  "name": "risk",
  "description": "Risk category",
  "valid_values": [
    "string"
  ]
}

Name	Type	Required	Description
name	string	true	Category name. Only accepts alphanumeric characters and underscore special character. Will not accept spaces
description	string	false	Category description
valid_values	[string]	false	Optional field to restrict the possible values that the category can have when it’s associated with the customer. If this field is empty or not present, the category can have any value when associated with the customer.

PatchCategory

1
2
3
4
5
6


{
  "description": "Risk category",
  "valid_values": [
    "string"
  ]
}

Name	Type	Required	Description
description	string	false	Category description
valid_values	[string]	false	Must include all values already present and new values to be added, or less values to be removed.

PostCustomerCategory

1
2
3
4
5
6


{
  "id": 214748364,
  "value": "influencer",
  "description": "Bill discount",
  "reason": "Masmovil sponsors their videos"
}

Name	Type	Required	Description
id	integer(int32)	true	Category id
value	string¦null	true	Category value.
description	string	false	Description of the category value.
reason	string	false	Reason for the set of value.

CustomerCategories

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


{
  "customer_id": "123e4567-e89b-12d3-a456-556642440000",
  "categories": [
    {
      "id": 214748364,
      "name": "risk",
      "value": "a",
      "description": "This is an a of category 1",
      "reason": "Change because this is a test",
      "create_date_time": "2022-01-01T01:01:01Z",
      "last_modified_date_time": "2022-01-01T01:01:01Z"
    }
  ]
}

Name	Type	Required	Description
customer_id	string(uuid)	true	Customer id
categories	[CustomerCategory]	true	Customer categories

CustomerCategory

1
2
3
4
5
6
7
8
9


{
  "id": 214748364,
  "name": "risk",
  "value": "a",
  "description": "This is an a of category 1",
  "reason": "Change because this is a test",
  "create_date_time": "2022-01-01T01:01:01Z",
  "last_modified_date_time": "2022-01-01T01:01:01Z"
}

Name	Type	Required	Description
id	integer(int32)	true	Category ID
name	string	false	Category name
value	string¦null	false	Category value. If null, category won’t be shown
description	string	false	Description of the category value
reason	string	false	Reason for the set of value
create_date_time	string(date-time)	false	Category creation date and time
last_modified_date_time	string(date-time)	false	Category last modified date and time

CustomerCategoryHistory

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


{
  "customer_id": "123e4567-e89b-12d3-a456-556642440000",
  "categories": [
    {
      "id": 214748364,
      "name": "risk",
      "historical_values": [
        {
          "value": "a",
          "description": "This is an a of category 1",
          "reason": "Change because this is a test",
          "create_date": "2022-01-01T01:01:01Z",
          "end_date": "2022-01-01T01:01:01Z",
          "last_modified_date": "2022-01-01T01:01:01Z",
          "modified_by": "user"
        }
      ]
    }
  ]
}

Name	Type	Required	Description
customer_id	string(uuid)	true	Customer id
categories	[CategoryHistory]	true	Customer categories with history

CategoryHistory

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


{
  "id": 214748364,
  "name": "risk",
  "historical_values": [
    {
      "value": "a",
      "description": "This is an a of category 1",
      "reason": "Change because this is a test",
      "create_date": "2022-01-01T01:01:01Z",
      "end_date": "2022-01-01T01:01:01Z",
      "last_modified_date": "2022-01-01T01:01:01Z",
      "modified_by": "user"
    }
  ]
}

Name	Type	Required	Description
id	integer(int32)	true	Customer category id
name	string	true	Category name
historical_values	[object]	true	none
» value	string	false	Category value
» description	string	false	Description of the category value
» reason	string	false	Reason for the set of value
» create_date	string(date-time)	false	Category creation date time
» end_date	string(date-time)¦null	false	Category end date time
» last_modified_date	string(date-time)	false	Category last modified date time
» modified_by	string	false	none

PatchCustomerCategory

1
2
3
4
5


{
  "value": "influencer",
  "description": "This is an a of category 1",
  "reason": "Riesgo por campañas de fidelizacion: Fidelizacion CP Outbound MM"
}

Name	Type	Required	Description
value	string¦null	false	Category value.
description	string¦null	false	Description of the category value.
reason	string¦null	false	Reason for the set of value.

Contracts

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


{
  "contracts": [
    {
      "id": "123e4567-e89b-12d3-a456-556642440000",
      "account_external_id": "214748364",
      "start_date": "2022-01-01T01:01:01Z",
      "end_date": "2022-01-01T01:01:01Z",
      "requests": [
        {
          "request_external_id": "214748364",
          "create_date": "2022-01-01T01:01:01Z",
          "contract_reference_id": "MMC2105077108808",
          "type": "SALE_MOBILE_ONLY",
          "origin_user": "john.doe"
        }
      ]
    }
  ]
}

Name	Type	Required	Description
contracts	[Contract]	true	Contracts

Contract

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


{
  "id": "123e4567-e89b-12d3-a456-556642440000",
  "account_external_id": "214748364",
  "start_date": "2022-01-01T01:01:01Z",
  "end_date": "2022-01-01T01:01:01Z",
  "requests": [
    {
      "request_external_id": "214748364",
      "create_date": "2022-01-01T01:01:01Z",
      "contract_reference_id": "MMC2105077108808",
      "type": "SALE_MOBILE_ONLY",
      "origin_user": "john.doe"
    }
  ]
}

Name	Type	Required	Description
id	string(uuid)	false	none
account_external_id	string	false	Account external id
start_date	string(date-time)	false	Contract start date
end_date	string(date-time)	false	Contract end date
requests	[ContractRequest]	false	Contract requests

ContractRequest

1
2
3
4
5
6
7


{
  "request_external_id": "214748364",
  "create_date": "2022-01-01T01:01:01Z",
  "contract_reference_id": "MMC2105077108808",
  "type": "SALE_MOBILE_ONLY",
  "origin_user": "john.doe"
}

Name	Type	Required	Description
request_external_id	string	false	Request id
create_date	string(date-time)	false	Category creation date
contract_reference_id	string	false	Contract reference id
type	string	false	Contract request type
origin_user	string	false	Origin user

ErrorResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "ref": "string",
      "details": "string"
    }
  ]
}

Name	Type	Required	Description
errors	[object]	false	none
» code	string	false	Customer error code
» title	string	false	Customer error title
» ref	string	false	none
» details	string	false	Detailed description of the error