{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/CustomerAddParameters",
"title": "CustomerAddParameters",
"required": [
"AccessToken",
"Client",
"ClientToken",
"LastName",
"OverwriteExisting"
],
"type": "object",
"properties": {
"ClientToken": {
"minLength": 1,
"type": "string",
"description": "Token identifying the client application."
},
"AccessToken": {
"minLength": 1,
"type": "string",
"description": "Access token of the client application."
},
"Client": {
"minLength": 1,
"type": "string",
"description": "Name and version of the client application."
},
"Title": {
"anyOf": [
{
"$ref": "#/components/schemas/Title"
}
],
"description": "Title prefix of the customer.",
"nullable": true
},
"FirstName": {
"type": "string",
"description": "First name of the customer.",
"nullable": true
},
"LastName": {
"minLength": 1,
"type": "string",
"description": "Last name of the customer."
},
"SecondLastName": {
"type": "string",
"description": "Second last name of the customer.",
"nullable": true
},
"NationalityCode": {
"type": "string",
"description": "ISO 3166-1 code of the `Country`.",
"nullable": true
},
"PreferredLanguageCode": {
"type": "string",
"description": "Language and culture code of the customer's preferred language, according to their profile. For example: `en-GB`, `fr-CA`.",
"nullable": true
},
"Sex": {
"anyOf": [
{
"$ref": "#/components/schemas/Sex"
}
],
"description": "Sex of the customer.",
"nullable": true
},
"BirthDate": {
"type": "string",
"description": "Date of birth in ISO 8601 format.",
"format": "date",
"nullable": true
},
"BirthCountryCode": {
"type": "string",
"description": "Country of birth.",
"nullable": true
},
"BirthCountrySubdivisionCode": {
"type": "string",
"description": "Province of birth.",
"nullable": true
},
"BirthPlace": {
"type": "string",
"description": "Place of birth.",
"nullable": true
},
"Occupation": {
"type": "string",
"description": "Occupation of the customer.",
"nullable": true
},
"Email": {
"type": "string",
"description": "Email address of the customer.",
"format": "email",
"nullable": true
},
"Phone": {
"type": "string",
"description": "Phone number of the customer (possibly mobile).",
"format": "tel",
"nullable": true
},
"LoyaltyCode": {
"type": "string",
"description": "Loyalty code of the customer.",
"nullable": true
},
"Notes": {
"type": "string",
"description": "Internal notes about the customer.",
"nullable": true
},
"CarRegistrationNumber": {
"maxLength": 255,
"type": "string",
"description": "Registration number of the customer's car.",
"nullable": true
},
"DietaryRequirements": {
"maxLength": 255,
"type": "string",
"description": "Customer's dietary requirements, e.g. Vegan, Halal.",
"nullable": true
},
"TaxIdentificationNumber": {
"type": "string",
"description": "Tax identification number of the customer.",
"nullable": true
},
"CompanyId": {
"type": "string",
"description": "Unique identifier of `Company` the customer is associated with.",
"format": "uuid",
"nullable": true
},
"Address": {
"title": "Address parameters",
"allOf": [
{
"$ref": "#/components/schemas/AddressParameters"
}
],
"description": "Address of the customer.",
"nullable": true
},
"IdentityCard": {
"title": "Identity document parameters",
"allOf": [
{
"$ref": "#/components/schemas/DocumentParameters"
}
],
"description": "Identity card details of the customer.",
"nullable": true,
"deprecated": true,
"x-deprecatedMessage": "Use [Add identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#add-identity-documents) to add document."
},
"Passport": {
"title": "Identity document parameters",
"allOf": [
{
"$ref": "#/components/schemas/DocumentParameters"
}
],
"description": "Passport details of the customer.",
"nullable": true,
"deprecated": true,
"x-deprecatedMessage": "Use [Add identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#add-identity-documents) to add document."
},
"Visa": {
"title": "Identity document parameters",
"allOf": [
{
"$ref": "#/components/schemas/DocumentParameters"
}
],
"description": "Visa details of the customer.",
"nullable": true,
"deprecated": true,
"x-deprecatedMessage": "Use [Add identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#add-identity-documents) to add document."
},
"DriversLicense": {
"title": "Identity document parameters",
"allOf": [
{
"$ref": "#/components/schemas/DocumentParameters"
}
],
"description": "Drivers license details of the customer.",
"nullable": true,
"deprecated": true,
"x-deprecatedMessage": "Use [Add identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#add-identity-documents) to add document."
},
"Classifications": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerClassificationEnum"
},
"description": "Classifications of the customer.",
"nullable": true
},
"Options": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerOptionEnum"
},
"description": "Options of the customer.",
"nullable": true
},
"ChainId": {
"type": "string",
"description": "Unique identifier of the chain. Required when using `PortfolioAccessTokens`, ignored otherwise.",
"format": "uuid",
"nullable": true
},
"OverwriteExisting": {
"type": "boolean",
"description": "Whether an existing customer should be overwritten in case of duplicity. This applies only to basic personal information (`Title`, `FirstName`, `LastName`, ...)."
},
"ItalianDestinationCode": {
"type": "string",
"description": "Value of Italian destination code.",
"nullable": true
},
"ItalianFiscalCode": {
"type": "string",
"description": "Value of Italian fiscal code.",
"nullable": true
},
"ItalianLotteryCode": {
"maxLength": 15,
"minLength": 2,
"type": "string",
"description": "Value of Italian lottery code.",
"nullable": true
}
},
"additionalProperties": false,
"x-schema-id": "CustomerAddParameters"
}