Client personal information, including address, contacts, identification documents etc.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Code |
Client code (i.e. Codice fiscale for Italian clients) |
string |
None. |
| CountryCode |
Client country code. ISO 3166-1 alpha-2 code for a country. |
string |
Max length: 2 |
| DateOfBirth |
Client date of birth in ISO 8601 format. |
date |
None. |
| DriverLicenceCountryCode | string |
None. |
|
| DriverLicenceTownCode | string |
None. |
|
| DriversLicenseImageBase64Back |
Base64Encoded string of the document image |
string |
None. |
| DriversLicenseImageBase64Front |
Base64Encoded string of the document image |
string |
None. |
| DriversLicenseIssueDate |
Client drivers license issue date. |
date |
None. |
| DriversLicenseIssuedIn |
Client drivers license town of issue. |
string |
None. |
| DriversLicenseNumber |
Client drivers license number. |
string |
None. |
| DriversLicenseValidUnlimited | boolean |
None. |
|
| DriversLicenseValidUntil |
Client drivers license valid until date. |
date |
None. |
|
Email address contact of the client. |
string |
None. |
|
| Email2 | string |
None. |
|
| Gender |
Client gender. Allowed values are: Male, Female. |
string |
Matching regular expression pattern: ^(male|female|Female|Male|FEMALE|MALE)$ |
| Id |
Identifier of booking client in provider system. |
integer |
None. |
| IdCardCountryCode | string |
None. |
|
| IdCardTownCode | string |
None. |
|
| IdentificationCardImageBase64Back |
Base64Encoded string of the document image |
string |
None. |
| IdentificationCardImageBase64Front |
Base64Encoded string of the document image |
string |
None. |
| IdentityCardIssueDate |
Client identity card issue date. |
date |
None. |
| IdentityCardIssuedIn |
Client identity card town of issue. |
string |
None. |
| IdentityCardNumber |
Client identity card number. |
string |
None. |
| IdentityCardValidUnlimited | boolean |
None. |
|
| IdentityCardValidUntil |
Client identity card valid until date. |
date |
None. |
| IsCompany |
Set to true if client is a company. Defaults to false. |
boolean |
None. |
| IsDriverLicenceDomestic | boolean |
None. |
|
| IsIdCardDomestic | boolean |
None. |
|
| IsPassportDomestic | boolean |
None. |
|
| Name |
Client first name. |
string |
None. |
| NationalityCode | string |
Max length: 2 |
|
| PassportCountryCode | string |
None. |
|
| PassportImageBase64Back |
Base64Encoded string of the document image |
string |
None. |
| PassportImageBase64Front |
Base64Encoded string of the document image |
string |
None. |
| PassportIssueDate |
Client passport issue date. |
date |
None. |
| PassportIssuedIn |
Client passport town of issue. |
string |
None. |
| PassportNumber |
Client passport number. |
string |
None. |
| PassportTownCode | string |
None. |
|
| PassportValidUnlimited | boolean |
None. |
|
| PassportValidUntil |
Client passport valid until date. |
date |
None. |
| Phone |
Telephone contact of the client. |
string |
None. |
| PostalCode |
Postal code part of client address. |
string |
None. |
| ProvinceCode | string |
None. |
|
| RecipientCode | string |
None. |
|
| RowVersion |
Identifier of document version. Prevents overwriting changes to same document. |
Collection of byte |
None. |
| Street |
Street and house number part of client address. |
string |
None. |
| Surname |
Client last name. |
string |
None. |
| TownName |
Town part of client address. |
string |
None. |
| VatId |
A value added tax identification number, or other personal identification number. |
string |
None. |