GET v1/Customers/{id}?Expand={Expand}
Retrieve Customer
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Customer id |
integer |
Required |
Expand | string |
None. |
Body Parameters
None.
Response Information
Resource Description
CustomerOutboundDTOName | Description | Type | Additional information |
---|---|---|---|
FirstName |
Customer first name |
string |
String length: inclusive between 0 and 30 |
Id |
Customer Id |
integer |
None. |
LastName |
Customer last name |
string |
String length: inclusive between 0 and 30 |
CommercialName |
Customer commercial name |
string |
String length: inclusive between 0 and 500 |
Type |
Customer type (Personal / Commercial) |
CustomerTypeEnum |
None. |
LegalStatus |
Customer legal status |
LegalStatusEnum |
None. |
RiskAddress |
Customer risk address |
EntityAddressDTO |
None. |
MailingAddress |
Customer mailing address |
EntityAddressDTO |
None. |
MobilePhone |
Customer mobile phone |
string |
String length: inclusive between 0 and 25 |
HomePhone |
Customer home phone |
string |
String length: inclusive between 0 and 25 |
WorkPhone |
Customer work phone |
string |
String length: inclusive between 0 and 25 |
SecondaryMobilePhone |
Customer work phone |
string |
String length: inclusive between 0 and 25 |
FaxNumber |
Customer Fax number |
string |
String length: inclusive between 0 and 25 |
Customer e-mail |
string |
String length: inclusive between 0 and 60 |
|
Quotes |
Customer's existing quotes |
Collection of QuoteOutboundDTO |
None. |
BirthDate |
Date of Birth of the customer |
date |
None. |
CitizenCountryId |
Customer’s Citizenship |
integer |
None. |
BirthCountryId |
Customer’s Country of Birth |
integer |
None. |
Fein |
Federal Employer Identification Number of the Customer |
string |
None. |
YearStarted |
Year when business was started |
integer |
None. |
EstablishCountryId |
Country where business was established |
integer |
None. |
ExternalCustomerNumber |
External Customer Number |
string |
None. |
Attributes |
Extended Customer Data Specific To Client |
Dictionary of string [key] and string [value] |
None. |
WarningMessages |
List of warning messages encountered while servicing request |
Collection of string |
None. |
Response Formats
application/json, text/json
{ "FirstName": "sample string 1", "Id": 2, "LastName": "sample string 3", "CommercialName": "sample string 4", "Type": "Unknown", "LegalStatus": "Unknown", "RiskAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "MailingAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "MobilePhone": "sample string 5", "HomePhone": "sample string 6", "WorkPhone": "sample string 7", "SecondaryMobilePhone": "sample string 8", "FaxNumber": "sample string 9", "Email": "sample string 10", "Quotes": [ { "AgencyId": 1, "AgentId": 1, "SubagencyId": 1, "DivisionOrganizationId": 1, "BillPlanId": 1, "RenewalBillPlanId": 1, "CustomerId": 1, "CompleteQuote": true, "EffectiveDate": "2024-10-11T22:50:22.5114166-10:00", "ExpirationDate": "2024-10-11T22:50:22.5114166-10:00", "QuoteTerm": "Unknown", "LineOfBusiness": "sample string 1", "PolicyNumber": "sample string 2", "Premium": 1.0, "PrimaryNamedInsured": { "FirstName": "sample string 1", "LastName": "sample string 2", "CommercialName": "sample string 3", "EmailAddress": "sample string 4", "HomePhone": "sample string 5", "MobilePhone": "sample string 6", "RiskAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "RiskAddressIsMailingAddress": true, "MailingAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "Type": "Unknown", "Id": 7 }, "QuoteNumber": "sample string 3", "RateGuaranteeDate": "2024-10-11T22:50:22.5114166-10:00", "RatingTaxa": "sample string 4", "State": "sample string 5", "Country": "sample string 6", "UnderwritingCompanyId": 7, "UniversalAccountId": 8, "AgencyCommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "SubagencyCommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "AgentCommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "AdditionalPayees": [ { "Type": "Unknown", "CommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "Id": 1 }, { "Type": "Unknown", "CommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "Id": 1 } ], "CustomQuoteNumber": "sample string 9", "QuoteName": "sample string 10", "UnderwriterId": 1, "UnderwritingResults": [ { "RuleCode": "sample string 1", "Message": "sample string 2" }, { "RuleCode": "sample string 1", "Message": "sample string 2" } ], "Id": 11 }, { "AgencyId": 1, "AgentId": 1, "SubagencyId": 1, "DivisionOrganizationId": 1, "BillPlanId": 1, "RenewalBillPlanId": 1, "CustomerId": 1, "CompleteQuote": true, "EffectiveDate": "2024-10-11T22:50:22.5114166-10:00", "ExpirationDate": "2024-10-11T22:50:22.5114166-10:00", "QuoteTerm": "Unknown", "LineOfBusiness": "sample string 1", "PolicyNumber": "sample string 2", "Premium": 1.0, "PrimaryNamedInsured": { "FirstName": "sample string 1", "LastName": "sample string 2", "CommercialName": "sample string 3", "EmailAddress": "sample string 4", "HomePhone": "sample string 5", "MobilePhone": "sample string 6", "RiskAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "RiskAddressIsMailingAddress": true, "MailingAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "Type": "Unknown", "Id": 7 }, "QuoteNumber": "sample string 3", "RateGuaranteeDate": "2024-10-11T22:50:22.5114166-10:00", "RatingTaxa": "sample string 4", "State": "sample string 5", "Country": "sample string 6", "UnderwritingCompanyId": 7, "UniversalAccountId": 8, "AgencyCommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "SubagencyCommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "AgentCommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "AdditionalPayees": [ { "Type": "Unknown", "CommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "Id": 1 }, { "Type": "Unknown", "CommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "Id": 1 } ], "CustomQuoteNumber": "sample string 9", "QuoteName": "sample string 10", "UnderwriterId": 1, "UnderwritingResults": [ { "RuleCode": "sample string 1", "Message": "sample string 2" }, { "RuleCode": "sample string 1", "Message": "sample string 2" } ], "Id": 11 } ], "BirthDate": "2024-10-11T22:50:22.5114166-10:00", "CitizenCountryId": 1, "BirthCountryId": 1, "Fein": "sample string 11", "YearStarted": 1, "EstablishCountryId": 1, "ExternalCustomerNumber": "sample string 12", "Attributes": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" } }
application/xml
Sample not available.
text/xml
Sample not available.