Maxxton External API

Sections

Authenticate a customer

Body Parameters

loginstring Required
passwordstring

Response

200
Object
The request is completed successfully without any errors

Response Attributes

customerIdinteger
readOnly
customerGroupIdinteger
titleIdinteger
firstNamestring

First name of customer and this is a restricted field. If you don't have access to this field, then **** will be returned as value.

Max length
50
middlestring

Middle name of customer and this is a restricted field. If you don't have access to this field, then **** will be returned as value.

lastNamestring

Last name of customer and this is a restricted field. If you don't have access to this field, then **** will be returned as value.

alternateNamestring

Alternate name of customer and this is a restricted field. If you don't have access to this field, then **** will be returned as value.

mailAddressobject

Show child attributes

emailAllowedboolean
mailAllowedboolean
phoneCallAllowedboolean

This field indicates if the customer has given us permission to contact them via phone call.

textMsgAllowedboolean

This field indicates if we can send text messages to the customer.

signatureDatestring
socialSecurityNumberstring

Social security number of customer and this is a restricted field. If you don't have access to this field, then **** will be returned as value.

genderstring

Gender of customer and this is a restricted field. If you don't have access to this field, then **** will be returned as value.

Enum values:
MALEFEMALEUNSPECIFIED
languageIdinteger
languagestring
readOnly
ibanNumberstring

IbanNumber of customer and this is a restricted field. If you don't have access to this field, then **** will be returned as value.

bicSwiftstring
birthDatestring

Birth date of customer and this is a restricted field. If you don't have access to this field, then 1800-01-01 will be returned as value.

companyNamestring

Company name of customer and this is a restricted field. If you don't have access to this field, then **** will be returned as value.

loginstring

Login id for the customer. Login field should be same as the email field in the customer address entity.

previousPmsIdinteger
creationDatestring
identityTypestring

Type of identity document provided by the customer.

Enum values:
PASSPORTIDENTITY_CARDDRIVERS_LICENCERESIDENCE_PERMITPERMANENT_RESIDENCE_CARDDIPLOMATIC_DOCUMENTELECTRONIC_ID_CARDNATIONAL_IDENTITY_DOCUMENTSPANISH_RESIDENCE_PERMITEU_RESIDENCE_PERMIT
... 3 other enums
identityNumberstring

Unique identification number as printed on the customer's identity document.

Max length
50
identityCountryIdinteger

Id of the country that issued the identity document..

identityDateIssuedstring

Date the identity document was issued.

identityExpirationDatestring

Date the identity document will expire.

taxIdentificationNumberstring

Tax identification number of the customer. 'Tax ID (NIF/CIF)' for Spain, 'Tax ID (Codice Fiscale)' for Italy, and 'Tax ID (SIRET/SIREN)' for France.

passwordModifiedDatestring

Password Modification Date of Customer Credentials

questionnaireUnsubscribedboolean
401
Object
Invalid credentials.
500
Object
Error occurred while authenticating this customer

POST

/

Select
1

Response