The Connect Web Services API is developed with a view of enhancing programmatic access to rating functionalities. Utilizing the Connect infrastructure, we have added our REST Web Services endpoints to the Rating API and Applicant API to help 3rd party organizations and their associated agencies to transition from SOAP to our modern tech stack.
\n
The Connect Web Services API is XML-based and is comprised of Applicant APIs and Rating APIs. The Applicant APIs are primarily used to directly create, get, or update Auto, Home or Dwelling Fire applicants and application data. It’s also used to get applicant details and delete or assign an existing XrefKey to an applicant.
\n
The Rating APIs, on the other hand, are used when the user needs to directly create or update Auto, Home or Dwelling Fire applicants with application data AND simultaneously submit a quote. It's also used to get quote execution details and applicant quote details.
Use: Provides Authentication. This call has to be made before making any other requests.
\n
Returns: Returns an access_token which should be set as an authorization header for the bearer (OAuth) token in the environment for the subsequent calls.
An authentication call has to be made before any other call to generate an access_token. This must be included in the header as a bearer token of subsequent requests.
\n
Authentication Workflow:
\n
\n
Generate an access token via our POST {{EzLynxIdentityUrl}}connect/token endpoint.
\n
\n
Each caller should use their specific client_secret and client_id that is provided by the EZLynx Connect Web Services team
\n
\n
The available scopes will be provided by the EZLynx Connect Web Services team
\n
\n
Calls must include openid for authentication
\n
\n
Users must specify the scopes regarding which APIs they need to access
\n
\n
A special QAS scope will be used only for SubmitQuote actions
\n
\n
Example: ApplicantApi RatingApi openid QAS
\n
\n
\n
\n
\n
The username must be provided by the caller
\n
\n
This is the target user on whose behalf this request is being made
\n
\n
\n
The grant_type must be set to vendor_data_access
\n
\n
Anyone using vendor_data_access must include the integration_group_Id which will be provided by the EZLynx Connect Web Services team.
\n
\n
The access_token should be sent with all subsequent requests.
\n
\n
The access_token will expire after a certain period of time and the user can make multiple requests until it expires, which eliminates the need to hit the authenticate token endpoint for each request.
\n
\n
Using an expired token will result in a 401 Unauthorized status code and the user will need to request a new token from this endpoint at this point (repeat from step 1).
You will configure a webhook url that will receive XML/json payloads. We will store the url for this webhook as part of your configuration during account setup. At setup, you will also tell us which events you'd like to receive. Available events are:
Use: Submits quote and creates applicant with Auto application.
\n
Returns: Returns an applicantId and quoteExecutionId
\n
Responses and Descriptions:
\n
\n
Success:
\n
Returns a 200 OK status code on success.
\n
\n
\n
Success with Warning- Invalid carrierId:
\n
Returns a 200 OK status code with a warning, if the request contains an invalidcarrierId.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in a valid carrierId to fix the issue, if desired.
\n
\n
\n
\n
\n
Success with warning- Married with no Co-Applicant:
\n
Returns a 200 OK status code with a warning, if the applicant status is provided as 'Married' in the request but no co-applicant info is specified.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can end in co-applicant information in the request to fix the issue, if desired.
\n
\n
\n
\n
\n
Bad Request- Invalid templateId:
\n
Returns a 400 Bad Request status code if the request contains an invalid templateId
\n
Send in a valid templateId to fix the issue.
\n
Since templates are managed by the target organization, users should receive a templateId from them.
Use: Submits quote and creates applicant with Auto application.
\n
Returns: Returns an applicantId and quoteExecutionId
\n
Responses and Descriptions:
\n
\n
Success:
\n
Returns a 200 OK status code on success.
\n
\n
\n
Success with Warning- Invalid carrierId:
\n
Returns a 200 OK status code with a warning, if the request contains an invalidcarrierId.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in a valid carrierId to fix the issue, if desired.
\n
\n
\n
\n
\n
Success with warning- Married with no Co-Applicant:
\n
Returns a 200 OK status code with a warning, if the applicant status is provided as 'Married' in the request but no co-applicant info is specified.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can end in co-applicant information in the request to fix the issue, if desired.
\n
\n
\n
\n
\n
Bad Request- Invalid templateId:
\n
Returns a 400 Bad Request status code if the request contains an invalid templateId
\n
Send in a valid templateId to fix the issue.
\n
Since templates are managed by the target organization, users should receive a templateId from them.
Use: Submits quote and creates Auto applicant with XrefKey and creates Auto application.
\n
Returns: Returns an applicantId and quoteExecutionId
\n
Responses and Descriptions:
\n
\n
Success:
\n
Returns a 200 OK status code on success.
\n
\n
\n
Success with Warning- Invalid carrierId:
\n
Returns a 200 OK status code with a warning, if the request contains an invalidcarrierId.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in a valid carrierId to fix the issue, if desired.
\n
\n
\n
\n
\n
Success with warning- Married with no Co-Applicant:
\n
Returns a 200 OK status code with a warning, if the applicant status is provided as 'Married' in the request but no co-applicant info is specified.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can end in co-applicant information in the request to fix the issue, if desired.
\n
\n
\n
\n
\n
Bad Request- Invalid templateId:
\n
Returns a 400 Bad Request status code if the request contains an invalid templateId
\n
Send in a valid templateId to fix the issue.
\n
Since templates are managed by the target organization, users should receive a templateId from them.
\n
\n
\n
\n
\n
\n
\n
Bad Request Invalid SSN:
\n
Request contains an invalid SSN.
\n
Send in a valid SSN to fix the issue.
\n
\n
\n
\n
\n
Bad Request Invalid Occupation:
\n
Request contains an invalid Occupation value.
\n
Send a valid Occupation value to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- Duplicate xRefKey:
\n
The xRefKey sent in the request is already in use by an existing applicant.
\n
Send in a unique xRefkey to fix the error.
\n
\n
\n
\n
\n
Bad Request xRefKey>64 characters
\n
Request contains an xRefKey that exceeds the maximum of 64 characters.
\n
Send in a valid xRefKey that contains not more than 64 characters to fix the issue.
Use: Submits quote and creates Auto applicant with XrefKey and creates Auto application.
\n
Returns: Returns an applicantId and quoteExecutionId
\n
Responses and Descriptions:
\n
\n
Success:
\n
Returns a 200 OK status code on success.
\n
\n
\n
Success with Warning- Invalid carrierId:
\n
Returns a 200 OK status code with a warning, if the request contains an invalidcarrierId.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in a valid carrierId to fix the issue, if desired.
\n
\n
\n
\n
\n
Success with warning- Married with no Co-Applicant:
\n
Returns a 200 OK status code with a warning, if the applicant status is provided as 'Married' in the request but no co-applicant info is specified.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can end in co-applicant information in the request to fix the issue, if desired.
\n
\n
\n
\n
\n
Bad Request- Invalid templateId:
\n
Returns a 400 Bad Request status code if the request contains an invalid templateId
\n
Send in a valid templateId to fix the issue.
\n
Since templates are managed by the target organization, users should receive a templateId from them.
\n
\n
\n
\n
\n
\n
\n
Bad Request Invalid SSN:
\n
Request contains an invalid SSN.
\n
Send in a valid SSN to fix the issue.
\n
\n
\n
\n
\n
Bad Request Invalid Occupation:
\n
Request contains an invalid Occupation value.
\n
Send a valid Occupation value to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- Duplicate xRefKey:
\n
The xRefKey sent in the request is already in use by an existing applicant.
\n
Send in a unique xRefkey to fix the error.
\n
\n
\n
\n
\n
Bad Request xRefKey>64 characters
\n
Request contains an xRefKey that exceeds the maximum of 64 characters.
\n
Send in a valid xRefKey that contains not more than 64 characters to fix the issue.
Use: Submits Auto quote, updates applicant and creates or replaces Auto application data by applicantId
\n
Returns: Returns an applicantId and a quoteExecutionId
\n
Responses and Descriptions:
\n
\n
Success:
\n
Returns a 200 OK status code on success.
\n
\n
\n
Success with Warning- Invalid carrierId:
\n
Returns a 200 OK status code with a warning, if the request contains an invalidcarrierId.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require the user to do anything. However, the user can send in a valid carrierId to fix the issue, if desired.
\n
\n
\n
\n
\n
Success with warning- Married with no Co-Applicant:
\n
Returns a 200 OK status code with a warning, if the applicant status is provided as 'Married' in the request but no co-applicant info is specified.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require the user to do anything. However, the user can send in co-applicant information in the request to fix the issue, if desired.
\n
\n
\n
\n
\n
Bad Request- Invalid templateId:
\n
Returns a 400 Bad Request status code if the request contains an invalid templateId
\n
Send in a valid templateId to fix the issue.
\n
Templates are managed by the target organization. Hence, users should receive a templateId from them.
Use: Submits Auto quote, updates applicant and creates or replaces Auto application data by applicantId
\n
Returns: Returns an applicantId and a quoteExecutionId
\n
Responses and Descriptions:
\n
\n
Success:
\n
Returns a 200 OK status code on success.
\n
\n
\n
Success with Warning- Invalid carrierId:
\n
Returns a 200 OK status code with a warning, if the request contains an invalidcarrierId.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require the user to do anything. However, the user can send in a valid carrierId to fix the issue, if desired.
\n
\n
\n
\n
\n
Success with warning- Married with no Co-Applicant:
\n
Returns a 200 OK status code with a warning, if the applicant status is provided as 'Married' in the request but no co-applicant info is specified.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require the user to do anything. However, the user can send in co-applicant information in the request to fix the issue, if desired.
\n
\n
\n
\n
\n
Bad Request- Invalid templateId:
\n
Returns a 400 Bad Request status code if the request contains an invalid templateId
\n
Send in a valid templateId to fix the issue.
\n
Templates are managed by the target organization. Hence, users should receive a templateId from them.
Use: Submits Auto quote, updates applicant and creates or replaces Auto application data by XrefKey
\n
Returns: Returns an applicantId and a quoteExecutionId
\n
Responses and Descriptions:
\n
\n
Success:
\n
Returns a 200 OK status code on success.
\n
\n
\n
Success with Warning- Invalid carrierId:
\n
Returns a 200 OK status code with a warning, if the request contains an invalidcarrierId.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require the user to do anything. However, the user can send in a valid carrierId to fix the issue, if desired.
\n
\n
\n
\n
\n
Success with warning- Married with no Co-Applicant:
\n
Returns a 200 OK status code with a warning, if the applicant status is provided as 'Married' in the request but no co-applicant info is specified.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require the user to do anything. However, the user can send in co-applicant information in the request to fix the issue, if desired.
\n
\n
\n
\n
\n
Bad Request- Invalid templateId:
\n
Returns a 400 Bad Request status code if the request contains an invalid templateId
\n
Send in a valid templateId to fix the issue.
\n
Templates are managed by the target organization. Hence, users should receive a templateId from them.
\n
\n
\n
\n
\n
\n
\n
Bad Request Invalid SSN:
\n
Request contains an invalid SSN.
\n
Send in a valid SSN to fix the issue.
\n
\n
\n
\n
\n
Bad Request Invalid Occupation:
\n
Request contains an invalid Occupation value.
\n
Send a valid Occupation value to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- No xRefKey:
\n
There is no xRefKey sent in the request.
\n
Send in a valid xRefkey to fix the error.
\n
\n
\n
\n
\n
Bad Request xRefKey>64 characters
\n
Request contains an xRefKey that exceeds the maximum of 64 characters.
\n
Send in a valid xRefKey that contains not more than 64 characters to fix the issue.
Use: Submits Auto quote, updates applicant and creates or replaces Auto application data by XrefKey
\n
Returns: Returns an applicantId and a quoteExecutionId
\n
Responses and Descriptions:
\n
\n
Success:
\n
Returns a 200 OK status code on success.
\n
\n
\n
Success with Warning- Invalid carrierId:
\n
Returns a 200 OK status code with a warning, if the request contains an invalidcarrierId.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require the user to do anything. However, the user can send in a valid carrierId to fix the issue, if desired.
\n
\n
\n
\n
\n
Success with warning- Married with no Co-Applicant:
\n
Returns a 200 OK status code with a warning, if the applicant status is provided as 'Married' in the request but no co-applicant info is specified.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require the user to do anything. However, the user can send in co-applicant information in the request to fix the issue, if desired.
\n
\n
\n
\n
\n
Bad Request- Invalid templateId:
\n
Returns a 400 Bad Request status code if the request contains an invalid templateId
\n
Send in a valid templateId to fix the issue.
\n
Templates are managed by the target organization. Hence, users should receive a templateId from them.
\n
\n
\n
\n
\n
\n
\n
Bad Request Invalid SSN:
\n
Request contains an invalid SSN.
\n
Send in a valid SSN to fix the issue.
\n
\n
\n
\n
\n
Bad Request Invalid Occupation:
\n
Request contains an invalid Occupation value.
\n
Send a valid Occupation value to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- No xRefKey:
\n
There is no xRefKey sent in the request.
\n
Send in a valid xRefkey to fix the error.
\n
\n
\n
\n
\n
Bad Request xRefKey>64 characters
\n
Request contains an xRefKey that exceeds the maximum of 64 characters.
\n
Send in a valid xRefKey that contains not more than 64 characters to fix the issue.
Returns: Returns vehicle data for exact or closest matches for the provided VIN.
\n
Responses and Descriptions:
\n
\n
200 OK: Exact or Closest match found.
\n
\n
404 Not Found: No matches are found.
\n
\n
400 Bad Request: If the user provides a VIN that closely matches a car manufactured after 1980, but contains invalid characters, then the endpoint will return a 400 Bad Request response.
\n
\n
401 Unauthorized: No token was provided.
\n
\n
\n","urlObject":{"path":["ApplicantApi","web-services","v1","auto","metadata","vin"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"1883d448-f780-450a-b1ad-8e65cd31a68e","name":"Exact Match Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\r\n1B52H************"},"url":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/vin"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"715"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Thu, 02 Nov 2023 18:37:56 GMT"}],"cookie":[],"responseTime":null,"body":"\n ExactMatch\n Exact VIN match found. 'VehicleResults' contains the matching vechicle information.\n 1B52H************\n \n \n 1B52H************\n FORD\n CUSTOM 500\n 1971\n COUPE 2\n Rear\n L \n \n No\n \n \n \n \n \n 0\n Gas\n \n \n"},{"id":"08e691bb-39bb-451d-8d61-b4e5cb7129a2","name":"Closest Match Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\r\nSGTATG***********"},"url":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/vin"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"1108"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Fri, 03 Nov 2023 14:37:00 GMT"}],"cookie":[],"responseTime":null,"body":"\n ClosestMatch\n An exact VIN match was not found. 'VehicleResults' contains closest matches.\n SGTATG***********\n \n \n SGTATG****1111111\n FORD\n COURIER \n 1978\n PICKUP \n Rear\n L \n \n No\n \n \n 1/2\n \n \n 3896\n Gas\n \n \n SGTATG****1111111\n FORD\n COURIER \n 1977\n PICKUP \n Rear\n L \n \n No\n \n \n 1/2\n \n \n 0\n Gas\n \n \n"},{"id":"f15d339c-ad2b-4ecd-971f-417bcbc066f9","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\r\n1356"},"url":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/vin"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"183"},{"key":"Content-Type","value":"application/problem+json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Fri, 03 Nov 2023 14:38:12 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.4\",\n \"title\": \"Not Found\",\n \"status\": 404,\n \"traceId\": \"00-3b26c852e286f2f9f12bc46840f0c108-bed67e00ff1c65a8-00\"\n}"},{"id":"e72691c5-2a2c-419f-b68d-524c1f9589b7","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\r\n1B52H************"},"url":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/vin"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"WWW-Authenticate","value":"Bearer error=\"invalid_token\", error_description=\"The token expired at '11/03/2023 15:14:11'\""},{"key":"Date","value":"Fri, 03 Nov 2023 15:21:50 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"fe25702b-92f5-4657-a377-860cd6d72ea7","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\r\n+HHES368+1+++++."},"url":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/vin"},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"273"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Fri, 03 Nov 2023 15:26:10 GMT"}],"cookie":[],"responseTime":null,"body":"\n VINInvalid\n The 'vin' parameter is not in a valid VIN format\n +HHES368+1+++++.\n"}],"_postman_id":"fa8dcbe8-9513-4bd1-bc75-6e9ddf240267"},{"name":"ValidateVin (With Location)","id":"6849a89e-e8bd-434a-8597-9bb26fdd8d72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\r\n1B52H************"},"url":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/vin-dest","description":"
Use: Sends a full VIN to obtain vehicle data with location.
\n
Returns: Returns same results as the POST ValidateVin endpoint except that a location indicator will be appended to each item for the provided VIN. Location indicator indicates the destination country of the manufactured vehicle.
\n
Responses and Descriptions:
\n
\n
200 OK : Exact or Closest match found
\n
Following are the countries and their respective codes being returned in the response: • Canada: C • Mexico: M • Puerto Rico: P • Empty
\n
\n
\n
404 Not Found: No matches are found
\n
400 Bad Request: If the user provides a VIN that closely matches a car manufactured after 1980, but contains invalid characters, then the endpoint will return a 400 Bad Request response.
Returns: Returns a list of years for vehicles (from 1966-2024).
\n
User can pass a valid Year obtained from this response in the GET Auto Makes endpoint to get a list of the Make of the vehicles based on the year provided.
Use: Gets Auto Makes based on the year provided in the request.
\n
Returns: Returns a list of Auto Manufacturers.
\n
User can pass a valid Year and Make in the GET Auto Models endpoint to get a list of Models for the vehicle.
\n
Responses and Descriptions:
\n
\n
200 OK : Successful
\n
401 Unauthorized: No token was provided
\n
Returns 400 Bad Request when:
\n
Sent without a year
\n
\n
\n
Returns 404 Not Found when:
\n
Sent with an invalid year
\n
\n
\n
\n","urlObject":{"path":["ApplicantApi","web-services","v1","auto","metadata","makes"],"host":["{{url}}"],"query":[{"key":"year","value":"2021"}],"variable":[]}},"response":[{"id":"b3d0cde7-4b33-4134-a6ee-4741ebf045b0","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/makes?year=2021","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","makes"],"query":[{"key":"year","value":"2021"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"1120"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Thu, 02 Nov 2023 18:40:35 GMT"}],"cookie":[],"responseTime":null,"body":"\n ACURA\n ALFA ROMEO\n ASTON MARTIN\n AUDI\n BENTLEY\n BMW\n BUICK\n CADILLAC\n CHEVROLET\n CHRYSLER\n DODGE\n FERRARI\n FIAT\n FORD\n GENESIS\n GMC\n HONDA\n HYUNDAI\n INFINITI\n ISUZU\n JAGUAR\n JEEP\n KIA\n LAMBORGHINI\n LAND ROVER\n LEXUS\n LINCOLN\n LOTUS\n MASERATI\n MAZDA\n MERCEDES-BENZ\n MINI\n MITSUBISHI\n NISSAN\n PORSCHE\n RAM\n ROLLS-ROYCE\n SUBARU\n TESLA\n TOYOTA\n VOLKSWAGEN\n VOLVO\n"},{"id":"fa998340-f19d-4bb8-b870-9ce921bb91e7","name":"Bad Request - No Year Input","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/makes?","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","makes"],"query":[{"key":"","value":null}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"446"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Fri, 03 Nov 2023 16:27:01 GMT"}],"cookie":[],"responseTime":null,"body":"\n 00000000-0000-0000-0000-000000000000\n Model Validation Error\n \n One or more validation errors occurred.\n \n \n InternalServerError\n false\n"},{"id":"1a57d2b6-30c4-450b-8821-fb6a849064d0","name":"Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/makes?year=1000","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","makes"],"query":[{"key":"year","value":"1000"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"183"},{"key":"Content-Type","value":"application/problem+json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Fri, 03 Nov 2023 16:28:24 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.4\",\n \"title\": \"Not Found\",\n \"status\": 404,\n \"traceId\": \"00-17a48cee9ca468e94c0908ccdec6963a-94069b35086cdbd6-00\"\n}"},{"id":"b81871cf-b5e4-4a48-b4a1-02c1c46f0d41","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/makes?year=2021","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","makes"],"query":[{"key":"year","value":"2021"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"WWW-Authenticate","value":"Bearer error=\"invalid_token\", error_description=\"The token expired at '11/06/2023 15:38:48'\""},{"key":"Date","value":"Mon, 06 Nov 2023 16:45:49 GMT"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"13aeb35c-53dd-4a23-ba57-fadb6e3727d3"},{"name":"Get Auto Models","id":"066675b7-cc12-41d7-ae61-15b82fdc1a7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/models?year=2021&make=ford","description":"
Use: Gets Auto Models based on the Year and Make provided in the request.
\n
Returns:
\n
Returns a list of Auto Models
\n
Responses and Descriptions:
\n
\n
200 OK : Successful
\n
401 Unauthorized: No token was provided
\n
Returns 400 Bad Request when sent:
\n
without a year
\n
without a make
\n
\n
\n
Returns 404 Not Found when sent:
\n
with invalid year
\n
with invalid make (Example: \"blue\")
\n
\n
\n
\n","urlObject":{"path":["ApplicantApi","web-services","v1","auto","metadata","models"],"host":["{{url}}"],"query":[{"key":"year","value":"2021"},{"key":"make","value":"ford"}],"variable":[]}},"response":[{"id":"805013d7-f875-4238-a4ff-8e135c803a34","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/models?year=2021&make=ford","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","models"],"query":[{"key":"year","value":"2021"},{"key":"make","value":"ford"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"2868"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Thu, 02 Nov 2023 18:40:55 GMT"}],"cookie":[],"responseTime":null,"body":"\n BRONCO BASE\n BRONCO FIRST EDITION\n BRONCO SPORT \n BRONCO SPORT BADLANDS\n BRONCO SPORT BIG BEND\n BRONCO SPORT FIRST EDITION\n BRONCO SPORT OUTER BANKS\n ECONOLINE E350 SUPER DUTY CUTAWAY VAN\n ECONOLINE E350 SUPER DUTY STRIPPED CHASSIS\n ECONOLINE E450 SUPER DUTY COMMERCIAL STRIPPED CHAS\n ECONOLINE E450 SUPER DUTY CUTAWAY VAN\n ECOSPORT S\n ECOSPORT SE\n ECOSPORT SES\n ECOSPORT TITANIUM\n ECOSPORT TREND\n EDGE SE\n EDGE SEL\n EDGE ST\n EDGE TITANIUM\n ESCAPE S\n ESCAPE SE\n ESCAPE SEL\n ESCAPE TITANIUM\n EXPEDITION KING RANCH\n EXPEDITION LIMITED\n EXPEDITION MAX KING RANCH\n EXPEDITION MAX LIMITED\n EXPEDITION MAX PLATINUM\n EXPEDITION MAX XL\n EXPEDITION MAX XLT\n EXPEDITION PLATINUM\n EXPEDITION XL\n EXPEDITION XLT\n EXPLORER \n EXPLORER KING RANCH\n EXPLORER LIMITED\n EXPLORER PLATINUM\n EXPLORER POLICE INTERCEPTOR\n EXPLORER ST\n EXPLORER TIMBERLINE\n EXPLORER XLT\n F150 \n F150 POLICE RESPONDER\n F150 RAPTOR\n F150 SSV\n F150 SUPER CAB\n F150 SUPERCREW\n F250 SUPER DUTY\n F350 SUPER DUTY\n F450 SUPER DUTY\n F53 \n F550 SUPER DUTY\n F59 \n F600 SUPER DUTY\n F650 SUPER DUTY\n F750 SUPER DUTY\n FIGO AMBIENTE\n FIGO TITANIUM\n GT \n GT CARBON SERIES\n GT HERITAGE EDITION\n GT LIQUID CARBON SERIES\n GT STUDIO COLLECTION\n MUSTANG \n MUSTANG GT\n MUSTANG MACH 1\n MUSTANG MACH-E CALIFORNIA ROUTE 1\n MUSTANG MACH-E GT\n MUSTANG MACH-E PREMIUM\n MUSTANG MACH-E SELECT\n MUSTANG SHELBY GT500\n RANGER XL\n RANGER XLT\n TRANSIT \n TRANSIT CONNECT TITANIUM\n TRANSIT CONNECT XL\n TRANSIT CONNECT XLT\n TRANSIT T-150\n TRANSIT T-250\n TRANSIT T-350\n TRANSIT T-350 HD\n"},{"id":"8c598a6f-c2d9-4f94-88ab-48c133cc7d50","name":"Bad Request - No Make Input","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/models?year=2021","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","models"],"query":[{"key":"year","value":"2021"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"446"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Fri, 03 Nov 2023 16:29:59 GMT"}],"cookie":[],"responseTime":null,"body":"\n 00000000-0000-0000-0000-000000000000\n Model Validation Error\n \n One or more validation errors occurred.\n \n \n InternalServerError\n false\n"},{"id":"c46d073c-fe31-452d-8a61-c5ae46f6bf6c","name":"Not Found - Invalid Make Input","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/models?year=2021&make=blue","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","models"],"query":[{"key":"year","value":"2021"},{"key":"make","value":"blue"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"183"},{"key":"Content-Type","value":"application/problem+json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Fri, 03 Nov 2023 16:33:13 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.4\",\n \"title\": \"Not Found\",\n \"status\": 404,\n \"traceId\": \"00-1388fbf8864363497d75057053775a16-b7433febab74c2c9-00\"\n}"},{"id":"96af1408-224f-450e-a13b-f53482900037","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/models?year=2021&make=ford","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","models"],"query":[{"key":"year","value":"2021"},{"key":"make","value":"ford"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"WWW-Authenticate","value":"Bearer error=\"invalid_token\", error_description=\"The token expired at '11/06/2023 15:38:48'\""},{"key":"Date","value":"Mon, 06 Nov 2023 16:46:14 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"5274c8c7-4734-4ee4-9290-668008f30d3c","name":"Bad Request - No Year Input","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/models?make=ford","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","models"],"query":[{"key":"make","value":"ford"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"446"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Tue, 06 Feb 2024 17:50:03 GMT"}],"cookie":[],"responseTime":null,"body":"\n 00000000-0000-0000-0000-000000000000\n Model Validation Error\n \n One or more validation errors occurred.\n \n \n InternalServerError\n false\n"},{"id":"05cd20f5-dd79-422b-888e-1148f031b305","name":"Not Found - Invalid Year Input","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/models?year=1000&make=ford","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","models"],"query":[{"key":"year","value":"1000"},{"key":"make","value":"ford"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"72"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Tue, 06 Feb 2024 17:52:11 GMT"}],"cookie":[],"responseTime":null,"body":"Models were not found for the year 1000, and make ford."}],"_postman_id":"066675b7-cc12-41d7-ae61-15b82fdc1a7a"},{"name":"Get Auto SubModels","id":"89dedbc5-5ce0-465d-96a1-c1a1282ebeb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models?year=2021&make=ford&model=BRONCO BASE","description":"
Use: Gets Auto Submodels of a vehicle including partial VIN. User needs to send in the Year, Make and Model of the vehicle in this request.
\n
Returns: Returns a list (string> of sub models with partial VIN, Body Style, Drive, Engine, Fuel and Transmission details.
\n
Responses and Descriptions:
\n
\n
200 OK : Successful.
\n
\n
401 Unauthorized: No token was provided.
\n
\n
Returns 400 Bad Request when sent:
\n
\n
without year
\n
without make
\n
without model
\n
with invalid year
\n
\n
\n
Returns 404 Not Found when:
\n
\n
No submodels exist with provided input.
\n
\n
\n
\n","urlObject":{"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models"],"host":["{{url}}"],"query":[{"key":"year","value":"2021"},{"key":"make","value":"ford"},{"key":"model","value":"BRONCO BASE"}],"variable":[]}},"response":[{"id":"fb78a4ed-6ff7-4280-a64a-1db96c8b82ba","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models?year=2021&make=ford&model=BRONCO BASE","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models"],"query":[{"key":"year","value":"2021"},{"key":"make","value":"ford"},{"key":"model","value":"BRONCO BASE"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"1356"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Thu, 02 Nov 2023 18:41:13 GMT"}],"cookie":[],"responseTime":null,"body":"\n SPORT UTILITY VEHICLE 2 4x4 2.3L Gas Manual |1FMEE5AH1M1111111\n SPORT UTILITY VEHICLE 2 4x4 2.3L L4 DOHC 16V Gas Manual |1FMDE5AH7M1111111\n SPORT UTILITY VEHICLE 2 4x4 2.7L Gas Automatic |1FMEE5AP2M1111111\n SPORT UTILITY VEHICLE 2 4x4 2.7L L4 DOHC 24V Gas Automatic |1FMDE5AP8M1111111\n SPORT UTILITY VEHICLE 2 AWD 2.3L Gas Manual |1FMEE5CH5M1111111\n SPORT UTILITY VEHICLE 2 AWD 2.3L L4 DOHC 16V Gas Manual |1FMDE5CH0M1111111\n SPORT UTILITY VEHICLE 2 AWD 2.7L Gas Automatic |1FMEE5CP6M1111111\n SPORT UTILITY VEHICLE 2 AWD 2.7L L4 DOHC 24V Gas Automatic |1FMDE5CP1M1111111\n SPORT UTILITY VEHICLE 4 4x4 2.3L L4 DOHC 16V Gas Manual |1FMDE5BH9M1111111\n SPORT UTILITY VEHICLE 4 4x4 2.7L Gas Automatic |1FMDE5BPXM1111111\n SPORT UTILITY VEHICLE 4 4x4 2.7L L4 DOHC 24V Gas Automatic |1FMEE5BP4M1111111\n SPORT UTILITY VEHICLE 4 AWD 2.3L L4 DOHC 16V Gas Manual |1FMEE5DH7M1111111\n SPORT UTILITY VEHICLE 4 AWD 2.7L Gas Automatic |1FMDE5DP3M1111111\n SPORT UTILITY VEHICLE 4 AWD 2.7L L4 DOHC 24V Gas Automatic |1FMEE5DP8M1111111\n"},{"id":"698df4c7-2d54-4ea9-aead-9654d01a2d22","name":"Bad Request (Sent without Year)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models?make=ford&model=BRONCO BASE","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models"],"query":[{"key":"make","value":"ford"},{"key":"model","value":"BRONCO BASE"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"446"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 06 Nov 2023 15:09:32 GMT"}],"cookie":[],"responseTime":null,"body":"\n 00000000-0000-0000-0000-000000000000\n Model Validation Error\n \n One or more validation errors occurred.\n \n \n InternalServerError\n false\n"},{"id":"3b6caef3-e7f5-46e9-a073-1d84ebd4c41b","name":"Bad Request (Sent without Make)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models?year=2021&model=BRONCO BASE","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models"],"query":[{"key":"year","value":"2021"},{"key":"model","value":"BRONCO BASE"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"446"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 06 Nov 2023 15:11:13 GMT"}],"cookie":[],"responseTime":null,"body":"\n 00000000-0000-0000-0000-000000000000\n Model Validation Error\n \n One or more validation errors occurred.\n \n \n InternalServerError\n false\n"},{"id":"ce8f6ef2-6616-4060-815f-47976f750ab4","name":"Bad Request (Sent without Model)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models?year=2021&make=ford","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models"],"query":[{"key":"year","value":"2021"},{"key":"make","value":"ford"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"446"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 06 Nov 2023 15:13:14 GMT"}],"cookie":[],"responseTime":null,"body":"\n 00000000-0000-0000-0000-000000000000\n Model Validation Error\n \n One or more validation errors occurred.\n \n \n InternalServerError\n false\n"},{"id":"2db0678e-ffb1-4525-a42d-ed57f669c4a4","name":"Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models?year=1960&make=ford&model=BRONCO BASE","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models"],"query":[{"key":"year","value":"1960"},{"key":"make","value":"ford"},{"key":"model","value":"BRONCO BASE"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"183"},{"key":"Content-Type","value":"application/problem+json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Mon, 06 Nov 2023 15:15:19 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.4\",\n \"title\": \"Not Found\",\n \"status\": 404,\n \"traceId\": \"00-426f62a2ce4d02114067ece9f87a7b0e-65548b126d27d982-00\"\n}"},{"id":"0d16a78c-769e-4bb5-bb73-e98581e3d4ee","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models?year=2021&make=ford&model=BRONCO BASE","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models"],"query":[{"key":"year","value":"2021"},{"key":"make","value":"ford"},{"key":"model","value":"BRONCO BASE"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"WWW-Authenticate","value":"Bearer error=\"invalid_token\", error_description=\"The token expired at '11/06/2023 15:38:48'\""},{"key":"Date","value":"Mon, 06 Nov 2023 16:46:36 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"96462b2e-337e-4034-a4b5-f1fcb3d41148","name":"Not Found - Invalid Year Input","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models?year=1000&make=ford&model=BRONCO BASE","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models"],"query":[{"key":"year","value":"1000"},{"key":"make","value":"ford"},{"key":"model","value":"BRONCO BASE"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"94"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Tue, 06 Feb 2024 17:53:15 GMT"}],"cookie":[],"responseTime":null,"body":"SubModels were not found for the year 1000, make ford, and model BRONCO BASE."}],"_postman_id":"89dedbc5-5ce0-465d-96a1-c1a1282ebeb8"},{"name":"Get Auto SubModels All","id":"b0a023c3-9ca1-4397-b747-bd6d09b67c06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/all?year=1000&make=ford&model=BRONCO BASE","description":"
Use Gets an unfiltered list of Auto Submodels including partial VIN. User needs to send in the Year, Make and Model of the vehicle in this request.
\n
Returns Gets an unfiltered list of auto submodels.
\n
Responses and Descriptions:
\n
\n
200 OK : Successful.
\n
\n
401 Unauthorized: No token was provided.
\n
\n
Returns 400 Bad Request when sent: o without year o without make o without model o with invalid year
\n
\n
Returns 404 Not Found when:
\n
\n
No submodels exist with provided input.
\n
\n
\n
\n","urlObject":{"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models","all"],"host":["{{url}}"],"query":[{"key":"year","value":"1000"},{"key":"make","value":"ford"},{"key":"model","value":"BRONCO BASE"}],"variable":[]}},"response":[{"id":"768826dc-792b-4b90-a93a-89943d9655f9","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/all?year=2021&make=ford&model=BRONCO BASE","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models","all"],"query":[{"key":"year","value":"2021"},{"key":"make","value":"ford"},{"key":"model","value":"BRONCO BASE"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"1356"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Thu, 02 Nov 2023 18:41:31 GMT"}],"cookie":[],"responseTime":null,"body":"\n SPORT UTILITY VEHICLE 2 4x4 2.3L Gas Manual |1FMEE5AH1M1111111\n SPORT UTILITY VEHICLE 2 4x4 2.3L L4 DOHC 16V Gas Manual |1FMDE5AH7M1111111\n SPORT UTILITY VEHICLE 2 4x4 2.7L Gas Automatic |1FMEE5AP2M1111111\n SPORT UTILITY VEHICLE 2 4x4 2.7L L4 DOHC 24V Gas Automatic |1FMDE5AP8M1111111\n SPORT UTILITY VEHICLE 2 AWD 2.3L Gas Manual |1FMEE5CH5M1111111\n SPORT UTILITY VEHICLE 2 AWD 2.3L L4 DOHC 16V Gas Manual |1FMDE5CH0M1111111\n SPORT UTILITY VEHICLE 2 AWD 2.7L Gas Automatic |1FMEE5CP6M1111111\n SPORT UTILITY VEHICLE 2 AWD 2.7L L4 DOHC 24V Gas Automatic |1FMDE5CP1M1111111\n SPORT UTILITY VEHICLE 4 4x4 2.3L L4 DOHC 16V Gas Manual |1FMDE5BH9M1111111\n SPORT UTILITY VEHICLE 4 4x4 2.7L Gas Automatic |1FMDE5BPXM1111111\n SPORT UTILITY VEHICLE 4 4x4 2.7L L4 DOHC 24V Gas Automatic |1FMEE5BP4M1111111\n SPORT UTILITY VEHICLE 4 AWD 2.3L L4 DOHC 16V Gas Manual |1FMEE5DH7M1111111\n SPORT UTILITY VEHICLE 4 AWD 2.7L Gas Automatic |1FMDE5DP3M1111111\n SPORT UTILITY VEHICLE 4 AWD 2.7L L4 DOHC 24V Gas Automatic |1FMEE5DP8M1111111\n"},{"id":"86ab53cf-2d23-4dab-bd7e-762aa718bf32","name":"Bad Request (Sent without Year)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/all?make=ford&model=BRONCO BASE","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models","all"],"query":[{"key":"make","value":"ford"},{"key":"model","value":"BRONCO BASE"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"446"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 06 Nov 2023 15:19:30 GMT"}],"cookie":[],"responseTime":null,"body":"\n 00000000-0000-0000-0000-000000000000\n Model Validation Error\n \n One or more validation errors occurred.\n \n \n InternalServerError\n false\n"},{"id":"ba0bb581-f467-41fa-85f0-abed50ba9011","name":"Bad Request (Sent without Make)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/all?year=2021&model=BRONCO BASE","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models","all"],"query":[{"key":"year","value":"2021"},{"key":"model","value":"BRONCO BASE"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"446"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 06 Nov 2023 15:20:26 GMT"}],"cookie":[],"responseTime":null,"body":"\n 00000000-0000-0000-0000-000000000000\n Model Validation Error\n \n One or more validation errors occurred.\n \n \n InternalServerError\n false\n"},{"id":"918a66df-2358-40a7-b727-965a673587e4","name":"Bad Request (Sent without Model)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/all?year=2021&make=ford","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models","all"],"query":[{"key":"year","value":"2021"},{"key":"make","value":"ford"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"446"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 06 Nov 2023 15:21:07 GMT"}],"cookie":[],"responseTime":null,"body":"\n 00000000-0000-0000-0000-000000000000\n Model Validation Error\n \n One or more validation errors occurred.\n \n \n InternalServerError\n false\n"},{"id":"5950ba91-1de8-470e-86be-e3fa33c15ed1","name":"Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/all?year=1960&make=ford&model=BRONCO BASE","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models","all"],"query":[{"key":"year","value":"1960"},{"key":"make","value":"ford"},{"key":"model","value":"BRONCO BASE"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"183"},{"key":"Content-Type","value":"application/problem+json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Mon, 06 Nov 2023 15:22:31 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.4\",\n \"title\": \"Not Found\",\n \"status\": 404,\n \"traceId\": \"00-1d59483aac367a314007b13d7d247137-70ed89ebab32c032-00\"\n}"},{"id":"a6c1f56c-0504-42ca-b14a-f2df53d0d930","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/all?year=2021&make=ford&model=BRONCO BASE","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models","all"],"query":[{"key":"year","value":"2021"},{"key":"make","value":"ford"},{"key":"model","value":"BRONCO BASE"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"WWW-Authenticate","value":"Bearer error=\"invalid_token\", error_description=\"The token expired at '11/06/2023 15:38:48'\""},{"key":"Date","value":"Mon, 06 Nov 2023 16:46:59 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"e602f501-f1f2-43bc-88e1-3a38e142f545","name":"Not Found - Invalid Year Input","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/all?year=1000&make=ford&model=BRONCO BASE","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models","all"],"query":[{"key":"year","value":"1000"},{"key":"make","value":"ford"},{"key":"model","value":"BRONCO BASE"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"94"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Tue, 06 Feb 2024 17:55:17 GMT"}],"cookie":[],"responseTime":null,"body":"SubModels were not found for the year 1000, make ford, and model BRONCO BASE."}],"_postman_id":"b0a023c3-9ca1-4397-b747-bd6d09b67c06"},{"name":"Get Auto SubModels (Masked VINs)","id":"206913f9-0653-4d45-8709-57056d4624cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/mask-vin?year=2021&make=ford&model=BRONCO BASE","description":"
Use: Gets Auto Submodels of a vehicle with masked VIN.
\n
Returns: Returns the same result as GET Auto Submodels endpoint a list of sub models with Body Style, Drive, Engine, Fuel and Transmission details), except that VINs will be masked.
\n
Responses and Descriptions:
\n
\n
200 OK : Successful.
\n
\n
401 Unauthorized: No token was provided.
\n
\n
Returns 400 Bad Request when sent:
\n
\n
without year
\n
without make
\n
without model
\n
with invalid year (eg 1000)
\n
\n
\n
Returns 404 Not Found when:
\n
\n
No submodels exist with provided input.
\n
\n
\n
\n","urlObject":{"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models","mask-vin"],"host":["{{url}}"],"query":[{"key":"year","value":"2021"},{"key":"make","value":"ford"},{"key":"model","value":"BRONCO BASE"}],"variable":[]}},"response":[{"id":"9b5a2bad-107e-4c2a-bd91-e284b4de092b","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/mask-vin?year=2021&make=ford&model=BRONCO BASE","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models","mask-vin"],"query":[{"key":"year","value":"2021"},{"key":"make","value":"ford"},{"key":"model","value":"BRONCO BASE"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"1207"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Thu, 02 Nov 2023 18:41:48 GMT"}],"cookie":[],"responseTime":null,"body":"\n SPORT UTILITY VEHICLE 2 4x4 2.3L Gas Manual |EZVIN0\n SPORT UTILITY VEHICLE 2 4x4 2.3L L4 DOHC 16V Gas Manual |EZVIN1\n SPORT UTILITY VEHICLE 2 4x4 2.7L Gas Automatic |EZVIN2\n SPORT UTILITY VEHICLE 2 4x4 2.7L L4 DOHC 24V Gas Automatic |EZVIN3\n SPORT UTILITY VEHICLE 2 AWD 2.3L Gas Manual |EZVIN4\n SPORT UTILITY VEHICLE 2 AWD 2.3L L4 DOHC 16V Gas Manual |EZVIN5\n SPORT UTILITY VEHICLE 2 AWD 2.7L Gas Automatic |EZVIN6\n SPORT UTILITY VEHICLE 2 AWD 2.7L L4 DOHC 24V Gas Automatic |EZVIN7\n SPORT UTILITY VEHICLE 4 4x4 2.3L L4 DOHC 16V Gas Manual |EZVIN8\n SPORT UTILITY VEHICLE 4 4x4 2.7L Gas Automatic |EZVIN10\n SPORT UTILITY VEHICLE 4 4x4 2.7L L4 DOHC 24V Gas Automatic |EZVIN11\n SPORT UTILITY VEHICLE 4 AWD 2.3L L4 DOHC 16V Gas Manual |EZVIN12\n SPORT UTILITY VEHICLE 4 AWD 2.7L Gas Automatic |EZVIN14\n SPORT UTILITY VEHICLE 4 AWD 2.7L L4 DOHC 24V Gas Automatic |EZVIN15\n"},{"id":"0299e636-2162-4a6c-8643-d4781f534db4","name":"Bad Request (Sent without Year)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/mask-vin?make=ford&model=BRONCO BASE","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models","mask-vin"],"query":[{"key":"make","value":"ford"},{"key":"model","value":"BRONCO BASE"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"446"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 06 Nov 2023 15:25:25 GMT"}],"cookie":[],"responseTime":null,"body":"\n 00000000-0000-0000-0000-000000000000\n Model Validation Error\n \n One or more validation errors occurred.\n \n \n InternalServerError\n false\n"},{"id":"d103dfa2-7fe5-448f-817a-0d85192d5897","name":"Bad Request (Sent without Make)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/mask-vin?year=2021&model=BRONCO BASE","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models","mask-vin"],"query":[{"key":"year","value":"2021"},{"key":"model","value":"BRONCO BASE"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"446"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 06 Nov 2023 15:27:00 GMT"}],"cookie":[],"responseTime":null,"body":"\n 00000000-0000-0000-0000-000000000000\n Model Validation Error\n \n One or more validation errors occurred.\n \n \n InternalServerError\n false\n"},{"id":"20e8ec2d-8d31-4467-bdbc-47839b918384","name":"Bad Request (Sent without Model)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/mask-vin?year=2021&make=ford","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models","mask-vin"],"query":[{"key":"year","value":"2021"},{"key":"make","value":"ford"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"446"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 06 Nov 2023 15:27:38 GMT"}],"cookie":[],"responseTime":null,"body":"\n 00000000-0000-0000-0000-000000000000\n Model Validation Error\n \n One or more validation errors occurred.\n \n \n InternalServerError\n false\n"},{"id":"2f068b91-964b-41ee-9354-de43f86d5729","name":"Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/mask-vin?year=1960&make=ford&model=BRONCO BASE","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models","mask-vin"],"query":[{"key":"year","value":"1960"},{"key":"make","value":"ford"},{"key":"model","value":"BRONCO BASE"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"183"},{"key":"Content-Type","value":"application/problem+json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Mon, 06 Nov 2023 15:28:19 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.4\",\n \"title\": \"Not Found\",\n \"status\": 404,\n \"traceId\": \"00-7d787e0441c72c7d5d4de82177fa8e6d-a3d005c3f5997db1-00\"\n}"},{"id":"01c37a07-34dc-424a-b1fb-76018ecf4d5b","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/mask-vin?year=2021&make=ford&model=BRONCO BASE","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models","mask-vin"],"query":[{"key":"year","value":"2021"},{"key":"make","value":"ford"},{"key":"model","value":"BRONCO BASE"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"WWW-Authenticate","value":"Bearer error=\"invalid_token\", error_description=\"The token expired at '11/06/2023 15:38:48'\""},{"key":"Date","value":"Mon, 06 Nov 2023 16:47:21 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"c19b9501-ab50-4807-8350-a8163ab6bbd5","name":"Not Found - Invalid Year Input","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/mask-vin?year=1000&make=ford&model=BRONCO BASE","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models","mask-vin"],"query":[{"key":"year","value":"1000"},{"key":"make","value":"ford"},{"key":"model","value":"BRONCO BASE"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"94"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Tue, 06 Feb 2024 17:56:45 GMT"}],"cookie":[],"responseTime":null,"body":"SubModels were not found for the year 1000, make ford, and model BRONCO BASE."}],"_postman_id":"206913f9-0653-4d45-8709-57056d4624cd"},{"name":"Get Auto SubModels (With Location)","id":"f38b51d6-995d-48ee-b484-40d8fedc810b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/include-locations?year=2015&make=AUDI&model=A7 TECHNIK","description":"
Use: Gets Auto Submodels of a vehicle with location data.
\n
Returns: Returns the same result as GET Auto Submodels endpoint (a list of sub models with Body Style, Drive, Engine, Fuel and Transmission details), except that a Location Indicator will be appended to each item and VINs will be masked.
\n
Responses and Descriptions:
\n
\n
200 OK : Exact or Closest match found.
\n
\n
Following are the countries and their respective codes being returned in the response: • Canada: C • Mexico: M • Puerto Rico: P • Empty
\n
\n
\n
Returns 400 Bad Request when sent:
\n
\n
without year
\n
without make
\n
without model
\n
with invalid year
\n
\n
\n
Returns 404 Not Found when:
\n
\n
No submodels exist with provided input.
\n
\n
\n
Returns 401 Unauthorized when:
\n
\n
No token was provided.
\n
\n
\n
\n","urlObject":{"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models","include-locations"],"host":["{{url}}"],"query":[{"key":"year","value":"2015"},{"key":"make","value":"AUDI"},{"key":"model","value":"A7 TECHNIK"}],"variable":[]}},"response":[{"id":"cc1a928a-b795-4d33-bed8-5372c13833de","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/include-locations?year=2015&make=AUDI&model=A7 TECHNIK","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models","include-locations"],"query":[{"key":"year","value":"2015"},{"key":"make","value":"AUDI"},{"key":"model","value":"A7 TECHNIK"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"206"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Thu, 02 Nov 2023 18:42:06 GMT"}],"cookie":[],"responseTime":null,"body":"\n HATCHBACK 4 AWD 3.0L L4 DOHC 24V Diesel Automatic |EZVIN0|C\n"},{"id":"2276e105-058b-4b46-9d04-2085d9c43b23","name":"Bad Request (Sent without Year)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/include-locations?make=AUDI&model=A7 TECHNIK","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models","include-locations"],"query":[{"key":"make","value":"AUDI"},{"key":"model","value":"A7 TECHNIK"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"446"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 06 Nov 2023 15:33:51 GMT"}],"cookie":[],"responseTime":null,"body":"\n 00000000-0000-0000-0000-000000000000\n Model Validation Error\n \n One or more validation errors occurred.\n \n \n InternalServerError\n false\n"},{"id":"3e4ebe27-5ccb-46be-bcd5-689a332edb36","name":"Bad Request (Sent without Make)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/include-locations?year=2015&model=A7 TECHNIK","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models","include-locations"],"query":[{"key":"year","value":"2015"},{"key":"model","value":"A7 TECHNIK"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"446"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 06 Nov 2023 15:35:01 GMT"}],"cookie":[],"responseTime":null,"body":"\n 00000000-0000-0000-0000-000000000000\n Model Validation Error\n \n One or more validation errors occurred.\n \n \n InternalServerError\n false\n"},{"id":"401b1e55-004b-4572-9f01-428a0e472949","name":"Bad Request (Sent without Model)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/include-locations?year=2015&make=AUDI","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models","include-locations"],"query":[{"key":"year","value":"2015"},{"key":"make","value":"AUDI"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"446"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 06 Nov 2023 15:36:27 GMT"}],"cookie":[],"responseTime":null,"body":"\n 00000000-0000-0000-0000-000000000000\n Model Validation Error\n \n One or more validation errors occurred.\n \n \n InternalServerError\n false\n"},{"id":"c8cc3924-016b-43d0-8e8c-6c5d48742674","name":"Not Found - Invalid Year Input","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/include-locations?year=1000&make=AUDI&model=A7 TECHNIK","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models","include-locations"],"query":[{"key":"year","value":"1000"},{"key":"make","value":"AUDI"},{"key":"model","value":"A7 TECHNIK"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"183"},{"key":"Content-Type","value":"application/problem+json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Mon, 06 Nov 2023 15:37:32 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.4\",\n \"title\": \"Not Found\",\n \"status\": 404,\n \"traceId\": \"00-e8ef441454d1a3973c97a5f4ac9d0ef9-9639adc569eb91f7-00\"\n}"},{"id":"fa07c74d-2ede-4430-a26e-8c2c4c580205","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/include-locations?year=2015&make=AUDI&model=A7 TECHNIK","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models","include-locations"],"query":[{"key":"year","value":"2015"},{"key":"make","value":"AUDI"},{"key":"model","value":"A7 TECHNIK"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"WWW-Authenticate","value":"Bearer error=\"invalid_token\", error_description=\"The token expired at '11/06/2023 15:38:48'\""},{"key":"Date","value":"Mon, 06 Nov 2023 16:47:43 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"3b0e5aeb-6421-4e70-8894-88d04ee28a7c","name":"Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/include-locations?year=1960&make=AUDI&model=A7 TECHNIK","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","auto","metadata","sub-models","include-locations"],"query":[{"key":"year","value":"1960"},{"key":"make","value":"AUDI"},{"key":"model","value":"A7 TECHNIK"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"93"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Tue, 06 Feb 2024 17:57:57 GMT"}],"cookie":[],"responseTime":null,"body":"SubModels were not found for the year 1960, make AUDI, and model A7 TECHNIK."}],"_postman_id":"f38b51d6-995d-48ee-b484-40d8fedc810b"}],"id":"4d2b9292-981e-4854-a574-34ca7bbbff3b","_postman_id":"4d2b9292-981e-4854-a574-34ca7bbbff3b","description":""}],"id":"a5186c42-ff6b-4203-8795-25e12bc79868","description":"
EZAuto Workflow
\n
The 2 distinct functionalities of EZAuto endpoints are the following:
\n\n
Create, get or update an applicant along with Auto application data, using the Applicant API.
\n
\n
Create or update an applicant along with Auto application data AND simultaneously submit quote, using the Rating API.
\n
\n\n
Please note that an applicant can be created with or without XrefKey in both scenarios.
\n
The EZAuto workflow is as follows:
\n
Authenticate:
\n
\n
Get a token via our POST {{EzLynxIdentityUrl}}connect/token endpoint.
\n
\n
This should be set as an authorization header for the bearer (OAuth) token in the environment for the subsequent calls (Refer to the 'Authenticate' section for more information).
\n
\n
\n
Once authenticated, user can utilize our API endpoints to either create a new applicant with Auto application or submit quote and simultaneously create an applicant with Auto application as follows:
\n
Create a new applicant with Auto application:
\n
Required scopes: openid ApplicantApi
\n
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/applicants/auto to create a new applicant with Auto application. This returns an applicantId and applicant details URL. OR
\n
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/applicants/auto?xrefKey={{Xref_key}} to create a new applicant with an XrefKey and create Auto application. This returns an applicantId and applicant details URL.
\n
\n
\n
Get Auto Application Details
\n
Required scopes: openid ApplicantApi
\n
Once an applicant is created with an auto application, users can get that application data, using the GET endpoints as follows:
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/:applicantId/auto to get application details by applicantId. OR
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/auto?xrefKey={{Xref_key}} and pass the XrefKey to get application details by XrefKey.
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/:applicantId/auto/acord to get an Auto application by applicantId in ACORD format.
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/auto/acord?xrefKey={{Xref_key}} and pass the XrefKey to get application details by XrefKey in ACORD format.
\n
\n
\n
Notes: The EZAuto GET endpoints are used to get Auto application details associated with Applicants. This endpoint will not return other applications such as Home or DwellingFire even if the applicant has those applications. In order to get the Home or DwellingFire applications, you can use endpoints belonging to their respective LOBs.
\n
Update Applicant and Auto Application Details
\n
Required scopes: openid ApplicantApi
\n
Users can utilize the EZAuto PUT endpoints to update an existing applicant and create or update Auto application details.
\n
\n
Make a request to PUT {{Url}}/ApplicantApi/web-services/v1/applicants/{{applicant_Id}}/auto to update an existing applicant and Auto application details by applicantId. This returns the applicantId of the updated applicant and applicant details URL. OR
\n
\n
Make a request to PUT {{Url}}/ApplicantApi/web-services/v1/applicants/auto?xrefKey={{Xref_key}} to update an existing applicant and Auto application details by XrefKey. This returns the applicantId of the updated applicant and applicant details URL.
\n
\n
\n
Please note that when an applicant is created with Auto application details, users can replace it with the new application details using the EZAuto PUT endpoints. Also, if there are no existing auto application details, the EZAuto PUT endpoints can be used to create one.
\n
An applicant can be created with different LOBs like Auto, Home and Dwelling Fire application details. If an applicant is created with a specific LOB application detail, that applicant can be updated to add another LOB application details to it, if required.
\n
VIN Validation
\n
It’s a recommended practice to validate VIN before submitting a quote. Users can utilize the VIN Validation endpoints for the following:
\n
Send Full VIN
\n
Required scopes: openid ApplicantApi
\n
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/auto/metadata/vin endpoint to send in the full VIN to obtain vehicle data. This returns vehicle data for exact or closest matches.
\n
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/auto/metadata/vin-dest endpoint to send in a full VIN to obtain vehicle data with location. This returns vehicle data for exact or closest matches with a location indicator appended to each item for the provided VIN.
\n
\n
\n
If a full VIN is not available, a partial VIN can be used to obtain vehicle data. In order to obtain a partial VIN, send in the Year, Make, and Model of a vehicle in the GET Auto Submodels endpoint and the call response will provide a partial VIN which can be included in the EZAuto application.
\n
GET Vehicle Year/Make/Model
\n
Required scopes: openid ApplicantApi
\n
\n
Make a request to GET Auto Years endpoint (GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/years) to get the Year of a vehicle. This returns a list of years for vehicles (ranges from 1966-2024).
\n
\n
Make a request to GET Auto Make endpoint (GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/makes?year=2021)and send in a valid Year obtained from the previous step to get the Make of the vehicle. This returns a list of auto manufacturers.
\n
\n
Make a request to GET Auto Models’ endpoint (GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/models?year=2021&make=ford) and send in a valid Year and Make obtained from the previous steps to get the Model for the vehicle. This returns a list of auto models based on the Year and Make provided.
\n
\n
\n
GET Auto Sub-Models
\n
Required scopes: openid ApplicantApi
\n
\n
Make a request to GET Auto Submodels endpoint (GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models?year=2021&make=ford&model=BRONCO BASE) to get the auto submodel of a vehicle including a partial VIN. This returns a list of submodels with VIN, Body Style, Drive, Engine, Fuel and Transmission details.
\n
\n
Make a request to GET Auto Submodels All endpoint (GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/all?year=2021&make=ford&model=BRONCO BASE) to get an unfiltered list of submodels with partial VIN.
\n
\n
Make a request to GET Auto Submodels (Masked VIN) endpoint (GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/mask-vin?year=2021&make=ford&model=BRONCO BASE) to get the auto submodel of a vehicle with masked partial VIN. This returns the same result as GET Auto Submodels endpoint except that VINs will be masked.
\n
\n
Make a request to GET Auto Submodels (With Location) endpoint (GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/include-locations?year=2015&make=AUDI&model=A7 TECHNIK). This returns the same result as GET Auto Submodels endpoint except that a Location Indicator will be appended to each item and partial VINs will be masked.
\n
\n
\n
Apart from creating an applicant and Auto application using the Applicant API, the users can also create an applicant with Auto application data and submit quote simultaneously using the following Rating API endpoints as follows:
\n
Submit Quote and create a new applicant with Auto application
\n
Required scopes: openid RatingApi QAS
\n
Our APIs can be utilized to submit quote and create applicant with Auto application as follows:
\n
\n
Make a request to POST {{Url}}/RatingApi/web-services/v1/quotes/auto to submit quote and create an applicant and Auto application. This returns an applicantId and quoteExecutionId. OR
\n
\n
Make a request to POST {{Url}}/RatingApi/web-services/v1/quotes/auto?xrefKey={{Xref_key}} to submit quote and create an applicant with Xref and create Auto application. This returns an applicantId and quoteExecutionId
\n
\n
\n
Submit Auto Quote and update Applicant with Auto Application data
\n
Required scopes: openid RatingApi QAS
\n
Users can utilize the EZAuto PUT endpoints to submit Auto Quote and update Applicant with Auto Application data.
\n
\n
Make a request to PUT {{Url}}/RatingApi/web-services/v1/quotes/applicants/{{applicant_Id}}/auto to submit Auto Quote and update Applicant with Auto Application data by applicantId. This returns the applicantId and quoteExecutionId . OR
\n
\n
Make a request to PUT {{Url}}/RatingApi/web-services/v1/quotes/auto?xrefKey={{Xref_key}} to submit Auto Quote and update Applicant with Auto Application data by XrefKey. This returns the applicantId and quoteExecutionId
\n
\n
\n
Lead Info
\n
EZLynx provides an option for mapping additional questions such as Lead Info and together information which are not part of the standard EZLynx fields mapped via EZ Auto and EZ Home XSD.
\n
Lead Info data can be mapped as part of Extended Info via EZ Auto and EZ Home XML’s, and can be uploaded via create applicant and submit quote APIs.
\n
Field Names
\n
The Following data elements can be captured and mapped:
\n
\n\n
\n
Field
\n
Max Length
\n
Values
\n
\n\n\n
\n
AccountName
\n
100
\n
\n
\n
\n
CustomerSince
\n
\n
yyyy-MM-dd
\n
\n
\n
ApplicantType
\n
\n
Enumeration (starts with): active = Active Client inactive = Inactive Client prospect = Prospect/Lead lead = Prospect/Lead
\n
\n
\n
ApplicantMaidenName
\n
64
\n
\n
\n
\n
ApplicantNickname
\n
64
\n
\n
\n
\n
CoApplicantMaidenName
\n
64
\n
\n
\n
\n
CoApplicantNickname
\n
64
\n
\n
\n
\n
LeadSource
\n
\n
Enumeration: visible values from Ezlynx UI
\n
\n
\n
LeadPriority
\n
\n
Enumeration: high, medium, low
\n
\n
\n
LeadStatus
\n
\n
Enumeration: visible values from Ezlynx UI
\n
\n
\n
ProbabilityOfSale
\n
\n
Enumeration: high, medium, low
\n
\n
\n
Description
\n
256
\n
\n
\n\n
\n
Notes:
\n
\n
The enumerations are not case sensitive. Can be all lower, UPPER or MiXeD.
\n
\n
ApplicantType is a bit of a special case, will match anything that starts with the words above, mapped to the value shown.
Use: Submits quote and creates applicant with Home application.
\n
Returns: Returns an applicantId and quoteExecutionId
\n
Responses and Descriptions:
\n
\n
Success:
\n
Returns a 200 OK status code on success.
\n
\n
\n
Success with Warning- Invalid carrierId:
\n
Returns a 200 OK status code with a warning, if the request contains an invalidcarrierId.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in a valid carrierId to fix the issue, if desired.
\n
\n
\n
\n
\n
Success with warning- Married with no Co-Applicant:
\n
Returns a 200 OK status code with a warning, if the applicant status is provided as 'Married' in the request but no co-applicant info is specified.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in co-applicant information in the request to fix the issue, if desired.
\n
\n
\n
\n
\n
Bad Request- Invalid templateId:
\n
Returns a 400 Bad Request status code if the request contains an invalid templateId
\n
Send in a valid templateId to fix the issue.
\n
Since templates are managed by the target organization, users should receive a templateId from them.
Use: Submits quote and creates applicant with Home application.
\n
Returns: Returns an applicantId and quoteExecutionId
\n
Responses and Descriptions:
\n
\n
Success:
\n
Returns a 200 OK status code on success.
\n
\n
\n
Success with Warning- Invalid carrierId:
\n
Returns a 200 OK status code with a warning, if the request contains an invalidcarrierId.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in a valid carrierId to fix the issue, if desired.
\n
\n
\n
\n
\n
Success with warning- Married with no Co-Applicant:
\n
Returns a 200 OK status code with a warning, if the applicant status is provided as 'Married' in the request but no co-applicant info is specified.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in co-applicant information in the request to fix the issue, if desired.
\n
\n
\n
\n
\n
Bad Request- Invalid templateId:
\n
Returns a 400 Bad Request status code if the request contains an invalid templateId
\n
Send in a valid templateId to fix the issue.
\n
Since templates are managed by the target organization, users should receive a templateId from them.
Use: Submits quote and creates Home applicant with xrefKey and creates Home application.
\n
Returns: Returns an applicantId and quoteExecutionId
\n
Responses and Descriptions:
\n
\n
Success:
\n
Returns a 200 OK status code on success.
\n
\n
\n
Success with Warning- Invalid carrierId:
\n
Returns a 200 OK status code with a warning, if the request contains an invalidcarrierId.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in a valid carrierId to fix the issue, if desired.
\n
\n
\n
\n
\n
Success with warning- Married with no Co-Applicant:
\n
Returns a 200 OK status code with a warning, if the applicant status is provided as 'Married' in the request but no co-applicant info is specified.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in co-applicant information in the request to fix the issue, if desired.
\n
\n
\n
\n
\n
Bad Request- Invalid templateId:
\n
Returns a 400 Bad Request status code if the request contains an invalid templateId
\n
Send in a valid templateId to fix the issue.
\n
Templates are managed by the target organization. Hence, users should receive a templateId from them.
\n
\n
\n
\n
\n
\n
\n
Bad Request Invalid SSN:
\n
Request contains an invalid SSN.
\n
Send in a valid SSN to fix the issue.
\n
\n
\n
\n
\n
Bad Request- Invalid Occupation:
\n
Request contains an invalid Occupation value.
\n
Send a valid Occupation value to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- Duplicate xRefKey:
\n
The xRefKey sent in the request is already in use by an existing applicant.
\n
Send in a unique xRefkey to fix the issue.
\n
\n
\n
\n
\n
Bad Request xRefKey>64 characters
\n
Request contains an xRefKey that exceeds the maximum of 64 characters.
\n
Send in a valid xRefKey that contains not more than 64 characters to fix the issue.
Use: Submits quote and creates Home applicant with xrefKey and creates Home application.
\n
Returns: Returns an applicantId and quoteExecutionId
\n
Responses and Descriptions:
\n
\n
Success:
\n
Returns a 200 OK status code on success.
\n
\n
\n
Success with Warning- Invalid carrierId:
\n
Returns a 200 OK status code with a warning, if the request contains an invalidcarrierId.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in a valid carrierId to fix the issue, if desired.
\n
\n
\n
\n
\n
Success with warning- Married with no Co-Applicant:
\n
Returns a 200 OK status code with a warning, if the applicant status is provided as 'Married' in the request but no co-applicant info is specified.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in co-applicant information in the request to fix the issue, if desired.
\n
\n
\n
\n
\n
Bad Request- Invalid templateId:
\n
Returns a 400 Bad Request status code if the request contains an invalid templateId
\n
Send in a valid templateId to fix the issue.
\n
Templates are managed by the target organization. Hence, users should receive a templateId from them.
\n
\n
\n
\n
\n
\n
\n
Bad Request Invalid SSN:
\n
Request contains an invalid SSN.
\n
Send in a valid SSN to fix the issue.
\n
\n
\n
\n
\n
Bad Request- Invalid Occupation:
\n
Request contains an invalid Occupation value.
\n
Send a valid Occupation value to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- Duplicate xRefKey:
\n
The xRefKey sent in the request is already in use by an existing applicant.
\n
Send in a unique xRefkey to fix the issue.
\n
\n
\n
\n
\n
Bad Request xRefKey>64 characters
\n
Request contains an xRefKey that exceeds the maximum of 64 characters.
\n
Send in a valid xRefKey that contains not more than 64 characters to fix the issue.
Use: Submits Home quote, updates applicant and creates or replaces Home application data by applicantId
\n
Returns: Returns an applicantId and a quoteExecutionId
\n
Responses and Descriptions:
\n
\n
Success:
\n
\n
Returns a 200 OK status code on success.
\n
\n
\n
Success with Warning- Invalid carrierId:
\n
\n
Returns a 200 OK status code with a warning, if the request contains an invalidcarrierId.
\n
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in a valid carrierId to fix the issue, if desired.
\n
\n
\n
\n
\n
Success with warning- Married with no Co-Applicant:
\n
\n
Returns a 200 OK status code with a warning, if the applicant status is provided as 'Married' in the request but no co-applicant info is specified.
\n
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in co-applicant information in the request to fix the issue, if desired.
\n
\n
\n
\n
\n
Bad Request- Invalid templateId:
\n
\n
Returns a 400 Bad Request status code if the request contains an invalid templateId
\n
Send in a valid templateId to fix the issue.
\n
Templates are managed by the target organization. Hence, users should receive a templateId from them.
Use: Submits Home quote, updates applicant and creates or replaces Home application data by applicantId
\n
Returns: Returns an applicantId and a quoteExecutionId
\n
Responses and Descriptions:
\n
\n
Success:
\n
\n
Returns a 200 OK status code on success.
\n
\n
\n
Success with Warning- Invalid carrierId:
\n
\n
Returns a 200 OK status code with a warning, if the request contains an invalidcarrierId.
\n
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in a valid carrierId to fix the issue, if desired.
\n
\n
\n
\n
\n
Success with warning- Married with no Co-Applicant:
\n
\n
Returns a 200 OK status code with a warning, if the applicant status is provided as 'Married' in the request but no co-applicant info is specified.
\n
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in co-applicant information in the request to fix the issue, if desired.
\n
\n
\n
\n
\n
Bad Request- Invalid templateId:
\n
\n
Returns a 400 Bad Request status code if the request contains an invalid templateId
\n
Send in a valid templateId to fix the issue.
\n
Templates are managed by the target organization. Hence, users should receive a templateId from them.
Use: Submits Home quote, updates applicant and creates or replaces Home application data by XrefKey.
\n
Returns: Returns an applicantId and a quoteExecutionId
\n
Responses and Descriptions:
\n
\n
Success:
\n
Returns a 200 OK status code on success.
\n
\n
\n
Success with Warning- Invalid carrierId:
\n
Returns a 200 OK status code with a warning, if the request contains an invalidcarrierId.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in a valid carrierId to fix the issue, if desired.
\n
\n
\n
\n
\n
Success with warning- Married with no Co-Applicant:
\n
Returns a 200 OK status code with a warning, if the applicant status is provided as 'Married' in the request but no co-applicant info is specified.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in co-applicant information in the request to fix the issue, if desired.
\n
\n
\n
\n
\n
Bad Request- Invalid templateId:
\n
Returns a 400 Bad Request status code if the request contains an invalid templateId
\n
Send in a valid templateId to fix the issue.
\n
Templates are managed by the target organization. Hence, users should receive a templateId from them.
\n
\n
\n
\n
\n
\n
\n
Bad Request- Invalid SSN:
\n
Request contains an invalid SSN.
\n
Send in a valid SSN to fix the issue.
\n
\n
\n
\n
\n
Bad Request- Invalid Occupation:
\n
Request contains an invalid Occupation value.
\n
Send a valid Occupation value to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- Duplicate xRefKey:
\n
The xRefKey sent in the request is already in use by an existing applicant.
\n
Send in a unique xRefkey to fix the issue.
\n
\n
\n
\n
\n
Bad Request xRefKey>64 characters
\n
Request contains an xRefKey that exceeds the maximum of 64 characters.
\n
Send in a valid xRefKey that contains not more than 64 characters to fix the issue.
Use: Submits Home quote, updates applicant and creates or replaces Home application data by XrefKey.
\n
Returns: Returns an applicantId and a quoteExecutionId
\n
Responses and Descriptions:
\n
\n
Success:
\n
Returns a 200 OK status code on success.
\n
\n
\n
Success with Warning- Invalid carrierId:
\n
Returns a 200 OK status code with a warning, if the request contains an invalidcarrierId.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in a valid carrierId to fix the issue, if desired.
\n
\n
\n
\n
\n
Success with warning- Married with no Co-Applicant:
\n
Returns a 200 OK status code with a warning, if the applicant status is provided as 'Married' in the request but no co-applicant info is specified.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in co-applicant information in the request to fix the issue, if desired.
\n
\n
\n
\n
\n
Bad Request- Invalid templateId:
\n
Returns a 400 Bad Request status code if the request contains an invalid templateId
\n
Send in a valid templateId to fix the issue.
\n
Templates are managed by the target organization. Hence, users should receive a templateId from them.
\n
\n
\n
\n
\n
\n
\n
Bad Request- Invalid SSN:
\n
Request contains an invalid SSN.
\n
Send in a valid SSN to fix the issue.
\n
\n
\n
\n
\n
Bad Request- Invalid Occupation:
\n
Request contains an invalid Occupation value.
\n
Send a valid Occupation value to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- Duplicate xRefKey:
\n
The xRefKey sent in the request is already in use by an existing applicant.
\n
Send in a unique xRefkey to fix the issue.
\n
\n
\n
\n
\n
Bad Request xRefKey>64 characters
\n
Request contains an xRefKey that exceeds the maximum of 64 characters.
\n
Send in a valid xRefKey that contains not more than 64 characters to fix the issue.
The 2 distinct functionalities of EZHome endpoints are the following:
\n\n
Create, get or update an applicant along with Home application data, using the Applicant API.
\n
\n
Create or update an applicant along with Home application data AND simultaneously submit quote, using the Rating API.
\n
\n\n
Please note that an applicant can be created with or without XrefKey in both scenarios.
\n
The EZHome workflow is as follows:
\n
Authenticate:
\n
\n
Get a token via our POST {{EzLynxIdentityUrl}}connect/token endpoint.
\n
\n
This should be set as an authorization header for the bearer (OAuth) token in the environment for the subsequent calls (Refer 'Authenticate' section for more information).
\n
\n
\n
Once authenticated, user can utilize our API endpoints to either create a new applicant with Home application or submit quote and create an applicant with Home Application as follows:
\n
Create a new applicant with Home Application:
\n
Required scopes: openid ApplicantApi
\n
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/applicants/home to create a new applicant and Home application data. This returns an applicantId and applicant details URL. OR
\n
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/applicants/home?xrefKey={{Xref_key}} to create a new applicant with an XrefKey and Home application data. This returns an applicantId and applicant details URL.
\n
\n
\n
Get Home application details:
\n
Required scopes: openid ApplicantApi
\n
Once an applicant is created with Home application, users can get that application details using the GET endpoints as follows:
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants//home and pass the applicantId to get application details by applicantId. OR
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/home?xrefKey={{Xref_key}} and pass the XrefKey to get application details by XrefKey.
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/20750670/home/acord to get application details by applicantId in ACORD format.
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/home/acord?xrefKey={{Xref_key}} to get application details by XrefKey in ACORD format.
\n
\n
\n
Notes: The EZHome GET endpoints are used to get Home application details associated with Applicants. This endpoint will not return other applications such as Auto or DwellingFire even if the applicant has those applications. In order to get the Auto or DwellingFire applications, you can use endpoints belonging to their respective LOBs.
\n
Update Applicant and Home Application Details
\n
Required scopes: openid ApplicantApi
\n
Users can utilize the EZHome PUT endpoints to update an existing applicant and create or update Home application details as follows:
\n
\n
Make a request to PUT {{Url}}/ApplicantApi/web-services/v1/applicants//home to update an existing applicant and Home application details by applicantId. This returns the applicantId of the updated applicant and applicant details URL. OR
\n
\n
Make a request to PUT {{Url}}/ApplicantApi/web-services/v1/applicants/home?xrefKey={{Xref_key}} to update an existing applicant and Home application details by XrefKey. This returns the applicantId of the updated applicant and applicant details URL.
\n
\n
\n
Please note that when an applicant is created with Home application details, users can replace it with the new application details using the EZHome PUT endpoints. Also, if there are no existing Home application details, the PUT endpoints can be used to create one.
\n
An applicant can be created with different LOBs like Auto, Home and Dwelling Fire application details. If an applicant is created with a specific LOB application detail, that applicant can be updated to add another LOB application details to it, if required.
\n
Apart from creating an applicant and Home application (as described above), the users can also create an applicant with Home application data and submit quote simultaneously using the following Rating API endpoints as follows:
\n
Submit Quote and create a new applicant with Home application
\n
Required scopes: openid RatingApi QAS
\n
Our APIs can be utilized to submit quote and create applicant with Home application as follows:
\n
\n
Make a request to POST {{Url}}/RatingApi/web-services/v1/quotes/home to submit quote and create an applicant and Home application. This returns an applicantId and quoteExecutionId. OR
\n
\n
Make a request to POST {{Url}}/RatingApi/web-services/v1/quotes/home?xrefKey={{Xref_key}} to submit quote and create an applicant with Xref and create Home application. This returns an applicantId and quoteExecutionId
\n
\n
\n
Submit Quote and update Applicant with Home Application data
\n
Required scopes: openid RatingApi QAS
\n
Users can utilize the EZHome PUT endpoints to submit Home Quote and update Applicant with Home Application data as follows:
\n
\n
Make a request to PUT {{Url}}/RatingApi/web-services/v1/quotes/applicants//home to submit Home Quote and update applicant with Home application data by applicantId. This returns the applicantId and quoteExecutionId
\n
\n
Make a request to PUT {{Url}}/RatingApi/web-services/v1/quotes/home?xrefKey={{Xref_key}} to submit Home Quote and update applicant with Home application data by XrefKey. This returns an applicantId and quoteExecutionId
\n
\n
\n
Lead Info
\n
EZLynx provides an option for mapping additional questions such as Lead Info and together information which are not part of the standard EZLynx fields mapped via EZ Auto and EZ Home XSD.
\n
Lead Info data can be mapped as part of Extended Info via EZ Auto and EZ Home XML’s, and can be uploaded via create applicant and submit quote APIs.
\n
Field Names
\n
The Following data elements can be captured and mapped:
\n
\n\n
\n
Field
\n
Max Length
\n
Values
\n
\n\n\n
\n
AccountName
\n
100
\n
\n
\n
\n
CustomerSince
\n
\n
yyyy-MM-dd
\n
\n
\n
ApplicantType
\n
\n
Enumeration (starts with): active = Active Client inactive = Inactive Client prospect = Prospect/Lead lead = Prospect/Lead
\n
\n
\n
ApplicantMaidenName
\n
64
\n
\n
\n
\n
ApplicantNickname
\n
64
\n
\n
\n
\n
CoApplicantMaidenName
\n
64
\n
\n
\n
\n
CoApplicantNickname
\n
64
\n
\n
\n
\n
LeadSource
\n
\n
Enumeration: visible values from Ezlynx UI
\n
\n
\n
LeadPriority
\n
\n
Enumeration: high, medium, low
\n
\n
\n
LeadStatus
\n
\n
Enumeration: visible values from Ezlynx UI
\n
\n
\n
ProbabilityOfSale
\n
\n
Enumeration: high, medium, low
\n
\n
\n
Description
\n
256
\n
\n
\n\n
\n
Notes:
\n
\n
The enumerations are not case sensitive. Can be all lower, UPPER or MiXeD.
\n
\n
ApplicantType is a bit of a special case, will match anything that starts with the words above, mapped to the value shown.
Use: Submits quote and creates applicant with Dwelling Fire application.
\n
Returns: Returns an applicantId and quoteExecutionId
\n
Responses and Descriptions:
\n
\n
Success:
\n
\n
Returns a 200 OK status code on success.
\n
\n
\n
Success with Warning- Invalid carrierId:
\n
\n
Returns a 200 OK status code with a warning, if the request contains an invalidcarrierId.
\n
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in a valid carrierId to fix the issue, if desired.
\n
\n
\n
\n
\n
Success with warning- Married with no Co-Applicant:
\n
\n
Returns a 200 OK status code with a warning, if the applicant status is provided as 'Married' in the request but no co-applicant info is specified.
\n
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in co-applicant information in the request to fix the issue, if desired.
\n
\n
\n
\n
\n
Bad Request- Invalid SSN:
\n
\n
Request contains an invalid SSN.
\n
Send in a valid SSN to fix the issue.
\n
\n
\n
\n
\n
Bad Request- Invalid Occupation:
\n
\n
Request contains an invalid Occupation value.
\n
\n
\n
Bad Request- Invalid templateId:
\n
\n
Returns a 400 Bad Request status code if the request contains an invalid templateId
\n
Send in a valid templateId to fix the issue.
\n
Since templates are managed by the target organization, users should receive a templateId from them.
Use: Submits quote and creates applicant with Dwelling Fire application.
\n
Returns: Returns an applicantId and quoteExecutionId
\n
Responses and Descriptions:
\n
\n
Success:
\n
\n
Returns a 200 OK status code on success.
\n
\n
\n
Success with Warning- Invalid carrierId:
\n
\n
Returns a 200 OK status code with a warning, if the request contains an invalidcarrierId.
\n
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in a valid carrierId to fix the issue, if desired.
\n
\n
\n
\n
\n
Success with warning- Married with no Co-Applicant:
\n
\n
Returns a 200 OK status code with a warning, if the applicant status is provided as 'Married' in the request but no co-applicant info is specified.
\n
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in co-applicant information in the request to fix the issue, if desired.
\n
\n
\n
\n
\n
Bad Request- Invalid SSN:
\n
\n
Request contains an invalid SSN.
\n
Send in a valid SSN to fix the issue.
\n
\n
\n
\n
\n
Bad Request- Invalid Occupation:
\n
\n
Request contains an invalid Occupation value.
\n
\n
\n
Bad Request- Invalid templateId:
\n
\n
Returns a 400 Bad Request status code if the request contains an invalid templateId
\n
Send in a valid templateId to fix the issue.
\n
Since templates are managed by the target organization, users should receive a templateId from them.
Use: Submits quote and creates Dwelling Fire applicant with XrefKey and creates Dwelling Fire application.
\n
Returns: Returns an applicantId and quoteExecutionId
\n
Responses and Descriptions:
\n
\n
Success:
\n
\n
Returns a 200 OK status code on success.
\n
\n
\n
Success with Warning- Invalid carrierId:
\n
\n
Returns a 200 OK status code with a warning, if the request contains an invalidcarrierId.
\n
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in a valid carrierId to fix the issue, if desired.
\n
\n
\n
\n
\n
Success with warning- Married with no Co-Applicant:
\n
\n
Returns a 200 OK status code with a warning, if the applicant status is provided as 'Married' in the request but no co-applicant info is specified.
\n
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in co-applicant information in the request to fix the issue, if desired.
\n
\n
\n
\n
\n
Bad Request- Invalid SSN:
\n
\n
Request contains an invalid SSN.
\n
Send in a valid SSN to fix the issue.
\n
\n
\n
\n
\n
Bad Request- Invalid Occupation:
\n
\n
Request contains an invalid Occupation value.
\n
\n
\n
400 Bad Request- Duplicate xRefKey:
\n
\n
The xRefKey sent in the request is already in use by an existing applicant.
\n
Send in a unique xRefkey to fix the error.
\n
\n
\n
\n
\n
Bad Request- Invalid templateId:
\n
\n
Returns a 400 Bad Request status code if the request contains an invalid templateId
\n
Send in a valid templateId to fix the issue.
\n
Since templates are managed by the target organization, users should receive a templateId from them.
Use: Submits quote and creates Dwelling Fire applicant with XrefKey and creates Dwelling Fire application.
\n
Returns: Returns an applicantId and quoteExecutionId
\n
Responses and Descriptions:
\n
\n
Success:
\n
\n
Returns a 200 OK status code on success.
\n
\n
\n
Success with Warning- Invalid carrierId:
\n
\n
Returns a 200 OK status code with a warning, if the request contains an invalidcarrierId.
\n
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in a valid carrierId to fix the issue, if desired.
\n
\n
\n
\n
\n
Success with warning- Married with no Co-Applicant:
\n
\n
Returns a 200 OK status code with a warning, if the applicant status is provided as 'Married' in the request but no co-applicant info is specified.
\n
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require any actions from the user. However, the user can send in co-applicant information in the request to fix the issue, if desired.
\n
\n
\n
\n
\n
Bad Request- Invalid SSN:
\n
\n
Request contains an invalid SSN.
\n
Send in a valid SSN to fix the issue.
\n
\n
\n
\n
\n
Bad Request- Invalid Occupation:
\n
\n
Request contains an invalid Occupation value.
\n
\n
\n
400 Bad Request- Duplicate xRefKey:
\n
\n
The xRefKey sent in the request is already in use by an existing applicant.
\n
Send in a unique xRefkey to fix the error.
\n
\n
\n
\n
\n
Bad Request- Invalid templateId:
\n
\n
Returns a 400 Bad Request status code if the request contains an invalid templateId
\n
Send in a valid templateId to fix the issue.
\n
Since templates are managed by the target organization, users should receive a templateId from them.
Use: Submits Dwelling Fire quote, updates applicant and creates or replaces Dwelling Fire application data by applicantId
\n
Returns: Returns an applicantId and a quoteExecutionId
\n
Responses and Descriptions:
\n
\n
Success:
\n
\n
Returns a 200 OK status code on success.
\n
\n
\n
Bad Request- Invalid carrierId:
\n
\n
Returns a 400 Bad Request status code, if the request contains an invalidcarrierId.
\n
User can send in a valid CarrierId to fix the issue.
\n
\n
\n
\n
\n
Success with warning- Married with no Co-Applicant:
\n
\n
Returns a 200 OK status code with a warning, if the applicant status is provided as 'Married' in the request but no co-applicant info is specified.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require the user to do anything. However, the user can send in co-applicant information in the request to fix the issue, if desired.
\n
\n
\n
\n
\n
Bad Request- Invalid SSN:
\n
\n
Request contains an invalid SSN.
\n
Send in a valid SSN to fix the issue.
\n
\n
\n
\n
\n
Bad Request- Invalid Occupation:
\n
\n
Request contains an invalid Occupation value.
\n
Send a valid Occupation value to fix the issue.
\n
\n
\n
\n
\n
Bad Request- Invalid templateId:
\n
\n
Returns a 400 Bad Request status code if the request contains an invalid templateId
\n
Send in a valid templateId to fix the issue.
\n
Since templates are managed by the target organization, users should receive a templateId from them.
Use: Submits Dwelling Fire quote, updates applicant and creates or replaces Dwelling Fire application data by applicantId
\n
Returns: Returns an applicantId and a quoteExecutionId
\n
Responses and Descriptions:
\n
\n
Success:
\n
\n
Returns a 200 OK status code on success.
\n
\n
\n
Bad Request- Invalid carrierId:
\n
\n
Returns a 400 Bad Request status code, if the request contains an invalidcarrierId.
\n
User can send in a valid CarrierId to fix the issue.
\n
\n
\n
\n
\n
Success with warning- Married with no Co-Applicant:
\n
\n
Returns a 200 OK status code with a warning, if the applicant status is provided as 'Married' in the request but no co-applicant info is specified.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require the user to do anything. However, the user can send in co-applicant information in the request to fix the issue, if desired.
\n
\n
\n
\n
\n
Bad Request- Invalid SSN:
\n
\n
Request contains an invalid SSN.
\n
Send in a valid SSN to fix the issue.
\n
\n
\n
\n
\n
Bad Request- Invalid Occupation:
\n
\n
Request contains an invalid Occupation value.
\n
Send a valid Occupation value to fix the issue.
\n
\n
\n
\n
\n
Bad Request- Invalid templateId:
\n
\n
Returns a 400 Bad Request status code if the request contains an invalid templateId
\n
Send in a valid templateId to fix the issue.
\n
Since templates are managed by the target organization, users should receive a templateId from them.
Use: Submits Dwelling Fire quote, updates applicant and creates or replaces Dwelling Fire application data by XrefKey.
\n
Returns: Returns an applicantId and a quoteExecutionId
\n
Responses and Descriptions:
\n
\n
Success:
\n
\n
Returns a 200 OK status code on success.
\n
\n
\n
Bad Request- Invalid carrierId:
\n
\n
Returns a 400 Bad Request status code, if the request contains an invalidcarrierId.
\n
User can send in a valid CarrierId to fix the issue.
\n
\n
\n
\n
\n
Success with warning- Married with no Co-Applicant:
\n
\n
Returns a 200 OK status code with a warning, if the applicant status is provided as 'Married' in the request but no co-applicant info is specified.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require the user to do anything. However, the user can send in co-applicant information in the request to fix the issue, if desired.
\n
\n
\n
\n
\n
Bad Request- Invalid SSN:
\n
\n
Request contains an invalid SSN.
\n
Send in a valid SSN to fix the issue.
\n
\n
\n
\n
\n
Bad Request- Invalid Occupation:
\n
\n
Request contains an invalid Occupation value.
\n
Send a valid Occupation value to fix the issue.
\n
\n
\n
\n
\n
Bad Request- Invalid templateId:
\n
\n
Returns a 400 Bad Request status code if the request contains an invalid templateId
\n
Send in a valid templateId to fix the issue.
\n
Since templates are managed by the target organization, users should receive a templateId from them.
Use: Submits Dwelling Fire quote, updates applicant and creates or replaces Dwelling Fire application data by XrefKey.
\n
Returns: Returns an applicantId and a quoteExecutionId
\n
Responses and Descriptions:
\n
\n
Success:
\n
\n
Returns a 200 OK status code on success.
\n
\n
\n
Bad Request- Invalid carrierId:
\n
\n
Returns a 400 Bad Request status code, if the request contains an invalidcarrierId.
\n
User can send in a valid CarrierId to fix the issue.
\n
\n
\n
\n
\n
Success with warning- Married with no Co-Applicant:
\n
\n
Returns a 200 OK status code with a warning, if the applicant status is provided as 'Married' in the request but no co-applicant info is specified.
\n
This warning is a hint to the user that the data they submitted may be inaccurate. It doesn’t prevent them from getting a quote and doesn’t necessarily require the user to do anything. However, the user can send in co-applicant information in the request to fix the issue, if desired.
\n
\n
\n
\n
\n
Bad Request- Invalid SSN:
\n
\n
Request contains an invalid SSN.
\n
Send in a valid SSN to fix the issue.
\n
\n
\n
\n
\n
Bad Request- Invalid Occupation:
\n
\n
Request contains an invalid Occupation value.
\n
Send a valid Occupation value to fix the issue.
\n
\n
\n
\n
\n
Bad Request- Invalid templateId:
\n
\n
Returns a 400 Bad Request status code if the request contains an invalid templateId
\n
Send in a valid templateId to fix the issue.
\n
Since templates are managed by the target organization, users should receive a templateId from them.
The 2 distinct functionalities of EZDwellingFire endpoints are the following:
\n\n
Create, get or update an applicant along with Dwelling Fire application data, using the Applicant API.
\n
\n
Create or update an applicant along with Dwelling Fire application data AND simultaneously submit quote, using the Rating API.
\n
\n\n
Please note that an applicant can be created with or without XrefKey in both scenarios.
\n
The EZDwellingFire workflow is as follows:
\n
Authenticate:
\n
\n
Get a token via our POST {{EzLynxIdentityUrl}}connect/token endpoint.
\n
\n
This should be set as an authorization header for the bearer (OAuth) token in the environment for the subsequent calls(Refer 'Authenticate' section for more information).
\n
\n
\n
Once authenticated, user can utilize our API endpoints to either create a new applicant with Dwelling Fire application or submit quote and create an applicant with Dwelling Fire Application as follows:
\n
Create a new applicant with Dwelling Fire Application
\n
Required scopes: openid ApplicantApi
\n
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/applicants/dwelling-fire to create a new applicant and Dwelling Fire application data. This returns an applicantId and applicant details URL. OR
\n
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/applicants/dwelling-fire?xrefKey={{Xref_key}} to create a new applicant with an XrefKey and Dwelling Fire application data. This returns an applicantId and applicant details URL.
\n
\n
\n
Get Dwelling Fire Applicant Details
\n
Required scopes: openid ApplicantApi
\n
Once a new Dwelling Fire applicant is created, you can get the applicant details or update the applicant as follows:
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants//dwelling-fire to get application details by applicantId. OR
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/dwelling-fire?xrefKey={{Xref_key}} and pass the XrefKey to get application details by XrefKey.
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/20750670/dwelling-fire/acord to get application details by applicantId in ACORD format. OR
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/dwelling-fire/acord?xrefKey=to get application details by XrefKey in ACORD format.
\n
\n
\n
Notes: The EZDwellingFire GET endpoints are used to get DwellingFire application details associated with Applicants. This endpoint will not return other applications such as Auto or Home even if the applicant has those applications. In order to get the Auto or Home applications, you can use endpoints belonging to their respective LOBs.
\n
Update Applicant and Dwelling Fire Application Details
\n
Required scopes: openid ApplicantApi
\n
Users can utilize the EZDwellingFire PUT endpoints to update an existing applicant and create or update Dwelling Fire application details as follows:
\n
\n
Make a request to PUT {{Url}}/ApplicantApi/web-services/v1/applicants//dwelling-fire to update an existing applicant and Dwelling Fire application details by applicantId. This returns an applicantId and applicant details URL. OR
\n
\n
Make a request to PUT {{Url}}/ApplicantApi/web-services/v1/applicants/dwelling-fire?xrefKey={{Xref_key}} to update an existing applicant and Dwelling Fire application details by XrefKey. This Returns an applicantId of the updated applicant and applicant details URL.
\n
\n
\n
Please note that when an applicant is created with Dwelling Fire application details, users can replace it with the new application details using the EZDwellingFire PUT endpoints. Also, if there are no existing Dwelling Fire application details, the PUT endpoints can be used to create one.
\n
An applicant can be created with different LOBs like Auto, Home and Dwelling Fire application details. If an applicant is created with a specific LOB application detail, that applicant can be updated to add another LOB application details to it, if required.
\n
Apart from creating an applicant and Dwelling Fire application (as described above), the users can also create an applicant with Dwelling Fire application and submit quote simultaneously using the following Rating API endpoints as follows:
\n
Submit Quote and create a new applicant with Dwelling Fire application
\n
Required scopes: openid RatingApi QAS
\n
Our APIs can be utilized to submit quote and create applicant with Dwelling Fire application as follows:
\n
\n
Make a request to POST {{Url}}/RatingApi/web-services/v1/quotes/dwelling-fire to submit quote and create an applicant and Dwelling Fire application. This returns an applicantId and quoteExecutionId. OR
\n
\n
Make a request to POST {{Url}}/RatingApi/web-services/v1/quotes/dwelling-fire?xrefKey={{Xref_key}} to submit quote and create an applicant with Xref and create Dwelling Fire application. This returns an applicantId and quoteExecutionId
\n
\n
\n
Submit Quote and update Applicant with Dwelling Fire Application data
\n
Required scopes: openid RatingApi QAS
\n
Users can utilize the EZDwellingFire PUT endpoints to submit Dwelling Fire Quote and update Applicant with Dwelling Fire Application data as follows:
\n
\n
Make a request to PUT {{Url}}/RatingApi/web-services/v1/quotes/applicants//dwelling-fire to submit Dwelling Fire Quote and update applicant with Dwelling Fire application data by applicantId. This returns an applicantId and quoteExecutionId
\n
\n
Make a request to PUT {{Url}}/RatingApi/web-services/v1/quotes/dwelling-fire?xrefKey={{Xref_key}} to submit Dwelling Fire Quote and update applicant with Dwelling Fire application data by XrefKey. This returns an applicantId and quoteExecutionId
\n
\n
\n
Lead Info
\n
EZLynx provides an option for mapping additional questions such as Lead Info and together information which are not part of the standard EZLynx fields mapped via EZ Auto and EZ Home XSD.
\n
Lead Info data can be mapped as part of Extended Info via EZ Auto and EZ Home XML’s, and can be uploaded via create applicant and submit quote APIs.
\n
Field Names
\n
The Following data elements can be captured and mapped:
\n
\n\n
\n
Field
\n
Max Length
\n
Values
\n
\n\n\n
\n
AccountName
\n
100
\n
\n
\n
\n
CustomerSince
\n
\n
yyyy-MM-dd
\n
\n
\n
ApplicantType
\n
\n
Enumeration (starts with): active = Active Client inactive = Inactive Client prospect = Prospect/Lead lead = Prospect/Lead
\n
\n
\n
ApplicantMaidenName
\n
64
\n
\n
\n
\n
ApplicantNickname
\n
64
\n
\n
\n
\n
CoApplicantMaidenName
\n
64
\n
\n
\n
\n
CoApplicantNickname
\n
64
\n
\n
\n
\n
LeadSource
\n
\n
Enumeration: visible values from Ezlynx UI
\n
\n
\n
LeadPriority
\n
\n
Enumeration: high, medium, low
\n
\n
\n
LeadStatus
\n
\n
Enumeration: visible values from Ezlynx UI
\n
\n
\n
ProbabilityOfSale
\n
\n
Enumeration: high, medium, low
\n
\n
\n
Description
\n
256
\n
\n
\n\n
\n
Notes:
\n
\n
The enumerations are not case sensitive. Can be all lower, UPPER or MiXeD.
\n
\n
ApplicantType is a bit of a special case, will match anything that starts with the words above, mapped to the value shown.
","_postman_id":"4027597f-2760-438a-b015-87bb28e895bd"},{"name":"Non-LOB Specific Endpoints","item":[{"name":"Xref Key","item":[{"name":"Assign Xref","event":[{"listen":"prerequest","script":{"id":"e92ac6a9-5b9f-450f-af0f-5cf92341e579","exec":["pm.collectionVariables.set(\"xref_key\", pm.variables.replaceIn(\"c83e729a-55f9-43dc-9aa6-e37755f5001f\"));"],"type":"text/javascript"}},{"listen":"test","script":{"id":"493795dc-2c6a-4699-8f36-f3686b32416d","exec":[""],"type":"text/javascript"}}],"id":"861bfaf7-7580-41e5-9409-c1d32c8aff5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey","description":"
Use: Assigns an XrefKey to an existing applicant, if that applicant is created without an XrefKey.
\n
Returns: Returns a 200 OK response on success. Please note that an applicant can be associated with only one Xrefkey. Hence, if the applicant is already created with an XrefKey, the user cannot assign a new Xref to that applicant and this request will return a 400 Bad Request Error message.
\n
NOTE: In order to change an existing XrefKey associated with an applicant, the user can utilize the Delete Xref endpoint to delete the existing Xrefkey first, and then use the PUT Assign Xref endpoint to assign a new XrefKey to that applicant.
\n
Responses and Descriptions:
\n
\n
Success:
\n
Returns a 200 OK status code on success.
\n
\n
\n
400 Bad Request- Duplicate xRefKey:
\n
The xRefKey sent in the request is already in use by an existing applicant.
\n","type":"text/plain"},"type":"any","value":"","key":"applicantId"}]}},"response":[{"id":"5e14eff5-e141-4b23-867f-bbece017fe08","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","applicants",":applicantId","xrefkey"],"variable":[{"key":"applicantId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Mon, 31 Jul 2023 14:15:39 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"c3d26752-0ec6-4dbf-83a5-0e371470ddd0","name":"Not Found","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ApplicantApi/web-services/v1/applicants/1234875410/xrefkey"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"137"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Wed, 06 Sep 2023 16:44:36 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"cb936bdd-3776-425b-a9a0-37a69cab7311\",\n \"message\": \"The applicant was not found.\",\n \"isUserFriendlyMessage\": true\n}"},{"id":"8d14922b-be9b-4b1c-9fb0-7ade97d6172c","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","applicants",":applicantId","xrefkey"],"variable":[{"key":"applicantId","value":"","description":"The ID of the Applicant"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"WWW-Authenticate","value":"Bearer error=\"invalid_token\", error_description=\"The token expired at '09/06/2023 16:25:02'\""},{"key":"Date","value":"Wed, 06 Sep 2023 16:41:49 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"cb815815-4c3d-4dda-8477-02066dbb7d27","name":"Forbidden","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ApplicantApi/web-services/v1/applicants/1234/xrefkey"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"163"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Wed, 06 Sep 2023 16:44:07 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"93b80df1-cc7a-4c08-9a9a-32c4a0067e4a\",\n \"message\": \"User does not have permission to perform this request.\",\n \"isUserFriendlyMessage\": true\n}"},{"id":"fcb15476-137a-4a25-abab-2794cc3c0b15","name":"Bad Request - Duplicate xrefKey","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","applicants",":applicantId","xrefkey"],"variable":[{"key":"applicantId","value":"","description":"The ID of the Applicant"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"380"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Mon, 12 Feb 2024 15:18:39 GMT"}],"cookie":[],"responseTime":null,"body":"\n 90bbf02e-b67b-4340-be7d-53a6adb0883e\n The xrefKey is already in use or the applicant already has an xrefKey.\n BadRequest\n true\n"}],"_postman_id":"861bfaf7-7580-41e5-9409-c1d32c8aff5f"},{"name":"Delete Xref","id":"d03a4129-7a0d-4c33-8c83-a2187077af4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey","description":"
Use: Deletes an existing XrefKey associated with an applicant.
\n
Returns: Returns a 200 OK response on success.
\n
NOTE: Once an existing XrefKey is deleted, users can utilize the PUT Assign Xref endpoint to assign a new XrefKey to that applicant, if required.
\n
Responses and Descriptions:
\n
\n
Success:
\n
Returns a 200 OK status code on success.
\n
\n
\n
\n","urlObject":{"path":["ApplicantApi","web-services","v1","applicants",":applicantId","xrefkey"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"","key":"applicantId"}]}},"response":[{"id":"ba14a483-b903-481f-949b-a354b614982d","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","applicants",":applicantId","xrefkey"],"variable":[{"key":"applicantId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Mon, 31 Jul 2023 14:15:55 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"fca02b62-3118-41d8-8748-d93595eafda4","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ApplicantApi/web-services/v1/applicants/1234086586/xrefkey"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"137"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Wed, 06 Sep 2023 16:46:11 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"6c515d37-e34d-4c1e-9987-6f6b1024e3f4\",\n \"message\": \"The applicant was not found.\",\n \"isUserFriendlyMessage\": true\n}"},{"id":"4ebbd18c-0537-463b-80ac-b538ad9973b6","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","applicants",":applicantId","xrefkey"],"variable":[{"key":"applicantId","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"WWW-Authenticate","value":"Bearer error=\"invalid_token\", error_description=\"The token expired at '09/06/2023 16:25:02'\""},{"key":"Date","value":"Wed, 06 Sep 2023 16:42:11 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"6067899a-35f0-4db8-96d5-519da0bcb570","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ApplicantApi/web-services/v1/applicants/1234/xrefkey"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"163"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Wed, 06 Sep 2023 16:45:47 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"1d9fb961-c551-424c-b24d-8f1448bafaa4\",\n \"message\": \"User does not have permission to perform this request.\",\n \"isUserFriendlyMessage\": true\n}"}],"_postman_id":"d03a4129-7a0d-4c33-8c83-a2187077af4c"}],"id":"f9042a47-0c51-4bb9-af6f-196111e0d86e","description":"
The XrefKey is a unique ID (up to 64 characters) used to identify the applicant within the user's system. Our XrefKey endpoints are used to:
\n
\n
Allow users to assign a new XrefKey to an applicant so that the organization can relate them to the data in their system.
\n
\n
Allow users to delete an existing XrefKey associated with an applicant so that the organization can delete an existing Xrefkey and assign a new XrefKey to the applicant, using the PUT Assign Xref endpoint, if required.
\n
\n
\n
Assign or Delete an Xref to an Existing Applicant
\n
Required scopes: openid ApplicantApi
\n
Once an applicant is created, users can utilize the Xref endpoints to assign or delete a new XrefKey to that applicant as provided below:
\n
\n
If the applicant is created without an XrefKey, make a request to PUT {{Url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey to assign an XrefKey to an existing applicant. This returns a 200 OK response on success. Please note that an applicant can be associated with only one XrefKey and this request will return an error, if there is an existing XrefKey associated with the applicant.
\n
\n
Make a request to DEL {{Url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey to delete an existing XrefKey associated with an applicant. This returns a 200 OK response on success. This functionality allows the user to delete the existing XrefKey so that the user can assign a new XrefKey to the applicant using the PUT {{Url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey endpoint, if required.
\n
\n
\n","_postman_id":"f9042a47-0c51-4bb9-af6f-196111e0d86e"},{"name":"Applicant Details","item":[{"name":"Get Applicant Details - By ApplicantId","id":"0d296c03-c113-48dc-a445-9cdea50b1436","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/ApplicantApi/web-services/v1/applicants/:applicantId","description":"
Use: Gets applicant details for a given applicantId
\n","type":"text/plain"},"key":"xrefKey","value":""}],"variable":[]}},"response":[{"id":"5ddab571-a11c-4dfb-b53a-44e2482c26bb","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/applicants?xrefKey=","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","applicants"],"query":[{"key":"xrefKey","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"1295"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Mon, 31 Jul 2023 14:16:37 GMT"}],"cookie":[],"responseTime":null,"body":"\n Hilma\n \n Harris\n Male\n MR\n Unknown\n Single\n Unknown\n Homemaker/House person / Homemaker/House person\n \n \n 20975891\n Unknown\n \n Current\n 123 test ave\n \n \n hous\n Austin\n TX\n 77573\n \n 3\n 0\n Unknown\n Unknown\n \n \n 7132314019\n \n \n \n \n PhoneMobile\n Unknown\n WebService\n 2023-07-31T09:16:30-05:00\n 2023-07-31T09:16:30.03-05:00\n"},{"id":"70213eae-5944-4868-b278-9088cbe29847","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/applicants?xrefKey=","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","applicants"],"query":[{"key":"xrefKey","value":"","description":"Maximum 64 character unique string"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"WWW-Authenticate","value":"Bearer error=\"invalid_token\", error_description=\"The token expired at '09/06/2023 18:10:03'\""},{"key":"Date","value":"Wed, 06 Sep 2023 18:39:08 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"b2be94ee-b256-4946-bdbe-6623fd0c7f26","name":"Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/applicants?xrefKey=1234","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","applicants"],"query":[{"key":"xrefKey","value":"1234","description":"Maximum 64 character unique string"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"135"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Wed, 06 Sep 2023 18:40:17 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"dee491a9-3f07-4751-8362-3794188e7005\",\n \"message\": \"The xrefKey was not found.\",\n \"isUserFriendlyMessage\": true\n}"},{"id":"dd45baa8-f732-47e3-a4f1-9c1b84a69b7f","name":"Bad Request - xrefKey > 65 characters","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/applicants?xrefKey=89798798979874946563516321654987498796514321654162516549874965168","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","applicants"],"query":[{"key":"xrefKey","value":"89798798979874946563516321654987498796514321654162516549874965168","description":"Maximum 64 character unique string"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"446"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 15:20:20 GMT"}],"cookie":[],"responseTime":null,"body":"\n 00000000-0000-0000-0000-000000000000\n Model Validation Error\n \n One or more validation errors occurred.\n \n \n InternalServerError\n false\n"}],"_postman_id":"debca3f2-0056-4800-92bd-d8be665decca"}],"id":"3416fd47-dbe2-47b8-9efd-c727d957acd0","description":"
The applicant details endpoints allow users to retrieve their agency’s accurate applicant details.
\n
Get Applicant Details:
\n
Required scopes: openid ApplicantApi
\n
Users can utilize the Applicant details endpoints to get the applicant details model for a given applicantId or XrefKey as follows:
\n
\n
Make a request to Get {{Url}}/ApplicantApi/web-services/v1/applicants/:applicantId to get applicant details by applicantId. This returns an Applicant details model.
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants?xrefKey={{Xref_key}} to get applicant details by XrefKey. This returns an applicant details model. However, if an applicant with a matching XrefKey does not exist, this will return a 404 Not Found error message.
QuoteExecutionId received from the DynamicPrompt event
\n","type":"text/plain"},"type":"any","value":"","key":"quoteExecutionId"}]}},"response":[{"id":"7f3d0474-5ec0-46c3-b556-d2e113278f41","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\n\r\n \r\n 21190916\r\n \r\n \r\n cboAgentCode\r\n 0A0165\r\n \r\n \r\n eftind\r\n Y\r\n \r\n \r\n intellidrive_travelers\r\n Yes\r\n \r\n \r\n \r\n","options":{"raw":{"language":"xml"}}},"url":{"raw":"{{url}}/RatingApi/v1/quote-executions/:quoteExecutionId","host":["{{url}}"],"path":["RatingApi","v1","quote-executions",":quoteExecutionId"],"variable":[{"key":"quoteExecutionId","value":"","description":"QuoteExecutionId received from the DynamicPrompt event"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Thu, 03 Aug 2023 13:35:43 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"9cb42d75-f490-434b-b7bf-a9bcd18e105f","name":"Not Found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\n\r\n \r\n 21190916\r\n \r\n \r\n cboAgentCode\r\n 0A0165\r\n \r\n \r\n eftind\r\n Y\r\n \r\n \r\n intellidrive_travelers\r\n Yes\r\n \r\n \r\n \r\n","options":{"raw":{"language":"xml"}}},"url":"{{url}}/RatingApi/v1/quote-executions/1234"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"No-Cache"},{"key":"Content-Length","value":"150"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Wed, 06 Sep 2023 16:20:51 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"b37a9a08-ccb5-43a3-bf7e-d52fab34fb4a\",\n \"message\": \"The quote execution detail was not found.\",\n \"isUserFriendlyMessage\": true\n}"},{"id":"99d6817a-0714-44b6-b183-6911d3ac4c82","name":"Unauthorized","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\n\r\n \r\n 21190916\r\n \r\n \r\n cboAgentCode\r\n 0A0165\r\n \r\n \r\n eftind\r\n Y\r\n \r\n \r\n intellidrive_travelers\r\n Yes\r\n \r\n \r\n \r\n","options":{"raw":{"language":"xml"}}},"url":{"raw":"{{url}}/RatingApi/v1/quote-executions/:quoteExecutionId","host":["{{url}}"],"path":["RatingApi","v1","quote-executions",":quoteExecutionId"],"variable":[{"key":"quoteExecutionId","value":"","description":"QuoteExecutionId received from the DynamicPrompt event"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"WWW-Authenticate","value":"Bearer error=\"invalid_token\", error_description=\"The token expired at '09/06/2023 16:25:02'\""},{"key":"Date","value":"Wed, 06 Sep 2023 16:31:09 GMT"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"b1213a94-6b8b-458d-9259-762c7bf2b710"}],"id":"4c287d49-f282-41b3-ba82-4c6794a5659f","description":"
These are questions that may be prompted after submitting a quote, typically with a \"Carrier needs additional information\" message. Questions for a carrier are tied to a Script Execution ID (also called Quote Execution ID) and a Prompt ID.
\n
Submit DynamicPromptResponses
\n
Required scopes: openid RatingApi
\n
The Submit Dynamic Prompts endpoint allows 3rd party organizations to submit their agency’s Dynamic Responses, so that they can provide answers to additional questions from Carriers. When a quote is submitted by the user (user of the organization) through our POST Submit Quote and Create Applicant with Auto Application endpoints, that request comes to EZLynx’s server. EZLynx processes the request and notifies the carrier that a quote request is submitted. If the carrier has additional questions that need to be answered before completing the quote, carrier sends those questions to EZLynx, and a DynamicPromptsRequired event will be invoked internally in EZLynx. Then, EZLynx calls the organization's webhook (API) and passes along those questions. User answers the questions and submits those to EZLynx through our POST Submit Dynamic Prompts endpoint.
\n
\n
In order to submit DynamicPromptResponses to continue carrier quoting, make a request to POST {{Url}}/RatingApi/v1/quote-executions/:quoteExecutionId endpoint. This returns a 200 OK response on success.
The Quote Execution Details endpoint allows users to retrieve Quote Execution Details from carriers by QuoteExecutionID
\n
Get Quote Execution Details
\n
Required scopes: openid RatingApi
\n
\n
Pass the quoteExecutionId in the request GET {{Url}}/ratingapi/web-services/v1/quote-executions/:quoteExecutionId endpoint to get quote information from carriers. This returns premium details or errors for the quote executed (quoteExecutionId)
QuoteId received from ApplicantQuoteCompleted event
\n","type":"text/plain"},"type":"any","value":"","key":"applicantQuoteId"}]}},"response":[{"id":"502d1d62-d467-4432-b384-5e3d3f0f6572","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/RatingApi/web-services/v1/quotes/:applicantQuoteId?includeAlternateQuotes=true","host":["{{url}}"],"path":["RatingApi","web-services","v1","quotes",":applicantQuoteId"],"query":[{"key":"includeAlternateQuotes","value":"true","description":"Include alternate quotes in the result set. "}],"variable":[{"key":"applicantQuoteId","value":"","description":"QuoteId received from `ApplicantQuoteCompleted` event "}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Length","value":"5046"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408tUser44596tOrg21414"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Thu, 18 Sep 2025 20:40:00 GMT"}],"cookie":[],"responseTime":null,"body":"\n \n 2783074\n 20975899\n 2023-08-03T10:56:39.54\n WebServices Testing\n 7/31/2023 10:03:36 AM Applicant info uploaded via XML file.\n 2023-08-10T00:00:00\n TX\n 0\n \n 10822425\n Succeeded\n \n 2023-08-03T10:56:40.277\n 2023-08-03T10:56:48.737\n 100\n 12 Months Premium = $3071.00<br>(CCF# 0009436356125) <br><br>Please access the quote proposal and ACORD docs within the Travelers quote and issue system<br>\n \n \n \n \n \n Auto\n 12\n 3071.00\n Paid-In-Full\n 3071.00\n \n \n 0009436356125\n CCF#\n https://plagt4.dev.travelers.com/enteserv/isrjump.asp?CCF=0009436356125&SearchType=04&TargetPage=1&Report=com.webcetera&AppKey=10821260&LOB=AUTO&WIPSOURCE=STRATEGIC&CycleDate=2023-08-10\n \n Yes\n \n \n 500/500\n \n \n 100000\n \n \n 500/500\n \n \n 500/500\n \n \n None\n \n \n 10000\n \n \n No Coverage\n \n \n 25000\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n Please access the quote proposal and ACORD docs within the Travelers quote and issue system\n \n \n This risk qualifies for Quantum Auto 2.0.\n \n \n \n \n 3071.00\n \n \n Paid-In-Full\n \n \n \n \n 3375.00\n \n \n 562.61\n \n \n 255.67\n \n \n EFT\n \n \n \n \n 3443.00\n \n \n 573.95\n \n \n 260.82\n \n \n Monthly\n \n \n \n \n \n 500/500\n 1092.00\n \n \n 500/500\n 367.00\n \n \n 100000\n 367.00\n \n \n 500\n 551.00\n \n \n 500\n 454.00\n \n \n 100\n 9.00\n \n \n 25000\n 110.00\n \n \n 10000\n 116.00\n \n \n \n 116.00\n \n \n \n \n \n \n \n"},{"id":"9be10fbf-882f-4046-bdab-49a186925c49","name":"Not Found","originalRequest":{"method":"GET","header":[],"url":"{{url}}/RatingApi/web-services/v1/quotes/1234985671"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"137"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Wed, 06 Sep 2023 16:47:57 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"f33e7bb5-f987-453e-8125-2f989d2711ca\",\n \"message\": \"The applicant was not found.\",\n \"isUserFriendlyMessage\": true\n}"},{"id":"1cc1686e-05c1-437d-b124-a577fd60958d","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/RatingApi/web-services/v1/quotes/:applicantQuoteId","host":["{{url}}"],"path":["RatingApi","web-services","v1","quotes",":applicantQuoteId"],"variable":[{"key":"applicantQuoteId","value":"","description":"QuoteId received from `ApplicantQuoteCompleted` event "}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"WWW-Authenticate","value":"Bearer error=\"invalid_token\", error_description=\"The token expired at '09/06/2023 16:25:02'\""},{"key":"Date","value":"Wed, 06 Sep 2023 16:33:19 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"d4bbd0ef-c739-484c-a8aa-9c3b341ffec4","name":"Forbidden","originalRequest":{"method":"GET","header":[],"url":"{{url}}/RatingApi/web-services/v1/quotes/1234"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"163"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Wed, 06 Sep 2023 16:47:34 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"f40775a3-7ebe-4aec-9e33-83e2a74a040e\",\n \"message\": \"User does not have permission to perform this request.\",\n \"isUserFriendlyMessage\": true\n}"}],"_postman_id":"ae14ea4a-caf6-4344-a4a3-3fc22ef0f3ee"}],"id":"5cd83be5-0931-4de8-86ad-9a1ec96aec6e","description":"
The Applicant Quote endpoint is used to retrieve an applicant's Quote Details.
\n
Get Applicant Quote Details
\n
Required scopes: openid RatingApi
\n
Once quotes are completed, an ApplicantQuoteCompleted event will be invoked internally in EZLynx which will contain the applicantQuoteID. EZLynx then calls the user’s webhook (API) with the applicantQuoteId.
\n
\n
Pass the applicantQuoteId in the request GET {{Url}}/RatingApi/web-services/v1/quotes/:applicantQuoteId?includeAlternateQuotes=true to get applicant quote details model. This returns applicantQuoteDetailsType data.
Use Validates applicant address and standardizes it. Addr2 and County can be added as additional (optional) inputs.
\n
Returns Returns an object of validated address. The returned address may :
\n
\n
Contain corrections (example: City, County, Zip)
\n
Will be in the USPS standardized format (example: may change “Street” to “ST”)
\n
Will include Zip+4
\n
\n
Responses and Descriptions:
\n
\n
200 OK: Successful
\n
400 Bad Request when sent:
\n
Without StreetName
\n
Without City
\n
Without StateCode
\n
Without Address
\n
Without Addr1
\n
\n
\n
\n","urlObject":{"path":["ApplicantApi","web-services","v1","address","validation"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"88946823-646f-47eb-8798-2d0f70dcece2","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\r\n\r\n\t\r\n\t\tCherry Street\r\n\t\t225\r\n\t\t8J\r\n\t\r\n\tNew York\r\n\tNY\r\n\tNew York\r\n\t10002\r\n"},"url":"{{url}}/ApplicantApi/web-services/v1/address/validation"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"499"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Mon, 06 Nov 2023 17:05:14 GMT"}],"cookie":[],"responseTime":null,"body":"\n \n \n CHERRY ST\n 225\n 8J\n \n \n NEW YORK\n NY\n NEW YORK\n 10002\n 8163\n Valid\n \n"},{"id":"1a9909aa-204e-44bf-8cae-865f6f54d53c","name":"Bad Request (Sent without Street Name)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\r\n\r\n\t\r\n\t\t\r\n\t\t225\r\n\t\t8J\r\n\t\r\n\tNew York\r\n\tNY\r\n\tNew York\r\n\t10002\r\n"},"url":"{{url}}/ApplicantApi/web-services/v1/address/validation"},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"253"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Fri, 10 Nov 2023 17:50:25 GMT"}],"cookie":[],"responseTime":null,"body":""},{"id":"8730d1f1-6f6b-4246-b510-9204ad23f28c","name":"Bad Request (Sent without City)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\r\n\r\n\t\r\n\t\tCherry Street\r\n\t\t225\r\n\t\t8J\r\n\t\r\n\t\r\n\tNY\r\n\tNew York\r\n\t10002\r\n"},"url":"{{url}}/ApplicantApi/web-services/v1/address/validation"},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"241"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Fri, 10 Nov 2023 17:54:50 GMT"}],"cookie":[],"responseTime":null,"body":""},{"id":"2a0a4dce-67b8-4a19-a716-2abe1f5df819","name":"Bad Request (Sent without State Code)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\r\n\r\n\t\r\n\t\tCherry Street\r\n\t\t225\r\n\t\t8J\r\n\t\r\n\tNew York\r\n\t\r\n\tNew York\r\n\t10002\r\n"},"url":"{{url}}/ApplicantApi/web-services/v1/address/validation"},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"446"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Fri, 10 Nov 2023 17:55:58 GMT"}],"cookie":[],"responseTime":null,"body":"\n 00000000-0000-0000-0000-000000000000\n Model Validation Error\n \n One or more validation errors occurred.\n \n \n InternalServerError\n false\n"},{"id":"6a7a7dcd-cc09-4ce5-b1b7-1c1d2d747b56","name":"Bad Request (Sent without Addr1)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\r\n\r\n\t\r\n\t\t\r\n\t\r\n\tNew York\r\n\tNY\r\n\tNew York\r\n\t10002\r\n"},"url":"{{url}}/ApplicantApi/web-services/v1/address/validation"},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"253"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Fri, 10 Nov 2023 17:57:55 GMT"}],"cookie":[],"responseTime":null,"body":""},{"id":"705a9dd7-46ab-40ff-9827-349726737535","name":"Bad Request (Sent without Address)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\r\n\r\n\t"},"url":"{{url}}/ApplicantApi/web-services/v1/address/validation"},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"446"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Tue, 14 Nov 2023 20:07:05 GMT"}],"cookie":[],"responseTime":null,"body":"\n 00000000-0000-0000-0000-000000000000\n Model Validation Error\n \n One or more validation errors occurred.\n \n \n InternalServerError\n false\n"},{"id":"d6a69238-f3e7-4763-bd1e-afe65725197f","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\r\n\r\n\t\r\n\t\tCherry Street\r\n\t\t225\r\n\t\t8J\r\n\t\r\n\tNew York\r\n\tNY\r\n\tNew York\r\n\t10002\r\n"},"url":"{{url}}/ApplicantApi/web-services/v1/address/validation"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"WWW-Authenticate","value":"Bearer"},{"key":"Date","value":"Mon, 12 Feb 2024 15:27:13 GMT"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"d3927b78-7d5d-47bf-8e32-56dc949ee0d5"}],"id":"3bf5ada8-b978-48c8-a39e-ddb3b0163fd6","description":"
The Applicant Address Validation endpoint is used to validate applicant address.
\n
Applicant Address Validation
\n
Required scopes: openid ApplicantApi
\n
Users can utilize the Applicant Validation endpoint to validate and standardize applicant address as follows:
\n
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/address/validation endpoint. Addr2 and County can be added as additional (optional) inputs in this request. This returns an object of validated address which may contain corrections (example: City, County, Zip), will be in the USPS standardized format (example: may change “Street” to “ST”) and include Zip+4.
There are some generic ApplicantAPI and RatingAPI endpoints that apply to all LOBs (EZAuto, EZHome, EZDwellingFire) to handle multiple functionalities.
Enumerable values for writing companies for a given MasterCompanyId. These values can be passed as parameters for requests to other endpoints in this API.
Send in a valid Status input to fix the issue. Possible values are: \"Accepted,Bound,CompletedNotBound,Declined,Incomplete,PolicyIssued,Quoted,Submitted\"
\n
\n
\n
\n
\n
400 Bad Request- Invalid Expiration Date
\n
\n
Request contains invalid `Expiration Date
\n
Send in a valid Expiration Date to fix the issue. Its important to note that \"Expiration Date cannot be prior to Effective Date\"
\n
\n
\n
\n
\n
400 Bad Request- Missing Quoted Date
\n
\n
Request is missing a QuoteDate input.
\n
Send in a valid QuoteDate to fix the issue as QuoteDate field is a required field.
\n
\n
\n
\n
\n
400 Bad Request- Invalid Premium Input
\n
\n
Request contains invalid Premium Input
\n
Send in a valid Premium Input to fix the issue. Its important to note that \"the field Premium must be between 1 and 1000000.\"
\n
\n
\n
\n
\n
400 Bad Request- Missing Rating State Input
\n
\n
Request is missing a Rating State Input
\n
Send in a valid Rating State input to fix the issue as RatingState field is a required field.
\n
\n
\n
\n
\n
400 Bad Request- Invalid CarrierId
\n
\n
Request contains invalid CarrierId
\n
Send in a valid CarrierId to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- Invalid LOB Input.
\n
\n
Request contains invalid LOB Input.
\n
Send in a valid LOB Input to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- Missing LOB Input
\n
\n
Request is missing a valid LOB Input
\n
Send in a valid LOB input to fix the issue as LOB field is a required field.
\n","type":"text/plain"},"type":"any","value":"{{externalQuoteSubmissionId}}","key":"externalQuoteSubmissionId"}]}},"response":[{"id":"d6a2b483-de7e-4e34-b3e7-a3ca31ed6708","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"text/plain"}],"url":{"raw":"{{url}}/RatingApi/v1/external-quote/submissions/:externalQuoteSubmissionId","host":["{{url}}"],"path":["RatingApi","v1","external-quote","submissions",":externalQuoteSubmissionId"],"variable":[{"key":"externalQuoteSubmissionId","value":"{{externalQuoteSubmissionId}}","description":"(Required) ExternalQuoteSubmissionId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"br"},{"key":"Vary","value":"Accept-Encoding"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Fri, 12 Jan 2024 15:24:32 GMT"}],"cookie":[],"responseTime":null,"body":"true"},{"id":"24b7ab10-5bb2-4f26-a0c2-5d65355d63b3","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"text/plain"}],"url":{"raw":"{{url}}/RatingApi/v1/external-quote/submissions/:externalQuoteSubmissionId","host":["{{url}}"],"path":["RatingApi","v1","external-quote","submissions",":externalQuoteSubmissionId"],"variable":[{"key":"externalQuoteSubmissionId","value":"1","description":"(Required) ExternalQuoteSubmissionId"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"163"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 19:39:45 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"5f65cfcb-68a3-46ca-a2fe-86b406fc9ca5\",\n \"message\": \"User does not have permission to perform this request.\",\n \"isUserFriendlyMessage\": true\n}"},{"id":"a546a8e8-6388-4696-8efe-024c9ad4fdac","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"text/plain"}],"url":{"raw":"{{url}}/RatingApi/v1/external-quote/submissions/:externalQuoteSubmissionId","host":["{{url}}"],"path":["RatingApi","v1","external-quote","submissions",":externalQuoteSubmissionId"],"variable":[{"key":"externalQuoteSubmissionId","value":"{{externalQuoteSubmissionId}}","description":"(Required) ExternalQuoteSubmissionId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"WWW-Authenticate","value":"Bearer"},{"key":"Date","value":"Mon, 12 Feb 2024 19:39:59 GMT"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"6bb54b47-0c9a-4685-b100-a757deb10f9c"}],"id":"d9bf0fdb-4bac-4315-94fb-4bd2f77ce9dc","_postman_id":"d9bf0fdb-4bac-4315-94fb-4bd2f77ce9dc","description":""}],"id":"0aaacd49-fef4-416e-99c4-af21a1c79f52","_postman_id":"0aaacd49-fef4-416e-99c4-af21a1c79f52","description":""}],"id":"b0a0bb65-16f6-40d4-9a03-45d73e23155b","description":"
External Quote Workflow:
\n
EZLynx refers to manually entered quotes as external quotes.
\n
Quotes:
\n
\n
Make a request to POST {{Url}}/RatingApi/v1/external-quote/:applicantId/quotes endpoint to create an external quote for the applicant. This returns an externalQuoteId
\n
Pass the externalQuoteId in the GET {{Url}}/RatingApi/v1/external-quote/quotes/:externalQuoteId request to get external quote with submissions for the given externalQuoteId. Or
\n
Pass the externalQuoteId in the GET {{url}}/RatingApi/v1/external-quote/:applicantId/quotes request to get all external quotes with submissions for the given applicantId.
\n
\n
Submissions:
\n
\n
Make a request to POST {{Url}}/RatingApi/v1/external-quote/:externalQuoteId/submissions to create additional external quote line of business (LOB) to the original external quote. This returns an externalQuoteSubmissionId.
\n
Pass the externalQuoteSubmissionId in the GET {{Url}}/RatingApi/v1/external-quote/submissions/:externalQuoteSubmissionId request to get the quote submission for that specific externalQuoteSubmissionId` Or
\n
Pass the externalQuoteSubmissionId in the PUT {{Url}}/RatingApi/v1/external-quote/submissions/:externalQuoteSubmissionId request to update the external quote submission. Or
\n
Pass the externalQuoteSubmissionId in the DEL {{Url}}/RatingApi/v1/external-quote/submissions/:externalQuoteSubmissionId request to delete the external quote submission. This returns a 200 OK status code on success.
Returns: Returns a lookup model with vehicle details, vehicle enhanced details and Driver's info, based on the applicantId and the integrationId
\n
Notes:
\n
\n
The organization should have Fenris API integration set up to consume the auto-lookup data.
\n
Its required to send in the applicantId and integrationId in the url.
\n
Its required to send in the LookupAddress in the body of the request.
\n
\n
Responses and Descriptions:
\n
\n
Success:
\n
Returns a 200 OK status code on success.
\n
\n
\n
400 Bad Request- Invalid IntegrationId
\n
Request contains invalid IntegrationId
\n
Send in a valid IntegrationIdto fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- Invalid ApplicantId
\n
Request contains invalid ApplicantId
\n
Send in a valid ApplicantId to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- Missing AddressLine 1
\n
Request is missing AddressLine 1
\n
Send in a valid AddressLine 1 to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- AddressLine 1 > 50 characters
\n
Request contains AddressLine 1 which exceeds a maximum length of 50.
\n
Send in a valid AddressLine 1 with a maximum length of 50.
\n
\n
\n
\n
\n
400 Bad Request- AddressLine 2 > 50 characters
\n
Request contains AddressLine 2 which exceeds a maximum length of 50.
\n
Send in a valid AddressLine 2 with a maximum length of 50.
\n
\n
\n
\n
\n
400 Bad Request- Unit > 5 characters
\n
Request contains Unit field that exceeds 5 characters.
\n
Send in a valid Unit field with a maximum length of 5 characters.
\n
\n
\n
\n
\n
400 Bad Request- Missing Zip Input
\n
Request is missing Zip input.
\n
Send in a valid Zip input to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- Zip <> 5 numbers
\n
Request contains a Zip input that doesn't contain 5 characters.
\n
Send in a valid Zip input that contain exactly 5 characters to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- Plus4 <> 4 numbers
\n
Request contains a Plus4 input that doesn't contain 4 characters.
\n
Send in a valid Plus4 Zip input that contain exactly 4 characters to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- Missing State Code Input
\n
Request is missing a State Code input.
\n
Send in a valid State Code input to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- State Code <> 2 numbers
\n
Request contains a State Code input that doesn't contain 2 characters.
\n
Send in a valid State Code input that contain exactly 2 characters to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- County > 50 characters
\n
Request contains County field that exceeds 50 characters.
\n
Send in a valid County field with a maximum length of 50 characters.
\n
\n
\n
\n
\n
400 Bad Request- Missing City Input
\n
Request is missing a City input.
\n
Send in a valid City input to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- City > 30 characters
\n
Request contains City field that exceeds 30 characters.
\n
Send in a valid City field with a maximum length of 30 characters.
\n
\n
\n
\n
\n
400 Bad Request- Years at Address > 15
\n
Request contains Years at Address field that exceeds 15 characters.
\n
Send in a valid Years at Address field that's between 0-15 characters.
\n
\n
\n
\n
\n
400 Bad Request- Years at Address < 0
\n
Request contains Years at Address field that is less than 0 characters.
\n
Send in a valid Years at Address field that's between 0-15 characters.
\n
\n
\n
\n
\n
400 Bad Request- MonthsAtAddress > 11
\n
Request contains Months at Address field that exceeds 11 characters.
\n
Send in a valid Months at Address field that's between 0-11 characters.
\n
\n
\n
\n
\n
400 Bad Request- MonthsAtAddress < 0
\n
Request contains Months at Address field that is less than 0 characters.
\n
Send in a valid Months at Address field that's between 0-11 characters.
\n
\n
\n
\n
\n
\n","urlObject":{"path":["RatingApi","v1","auto-lookup","web-services","applicants","21200658"],"host":["{{url}}"],"query":[{"key":"integrationId","value":"9823"}],"variable":[]}},"response":[{"id":"c010ce25-6724-4df2-9a92-98966788a882","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"addressType\": 1,\n \"addressLine1\": \"1295 BETTY LANE\",\n \"addressLine2\": \"\",\n \"unit\": \"\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/applicants/21200658?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","applicants","21200658"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"br"},{"key":"Vary","value":"Accept-Encoding"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Mon, 22 Jan 2024 22:17:18 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"vehicles\": [\n {\n \"model\": \"QUEST\",\n \"make\": \"NISSAN\",\n \"year\": 2012,\n \"fuel\": \"Gas\",\n \"vehicleType\": \"Van\"\n },\n {\n \"model\": \"CAMRY\",\n \"make\": \"TOYOTA\",\n \"year\": 2011,\n \"fuel\": \"Gas\",\n \"vehicleType\": \"Sedan\"\n },\n {\n \"model\": \"ALTIMA\",\n \"make\": \"NISSAN\",\n \"year\": 2006,\n \"fuel\": \"Gas\",\n \"vehicleType\": \"Sedan\"\n }\n ],\n \"vehiclesEnhanced\": [\n {\n \"bodyStyle\": \"SPORT UTILITY VEHICLE 4\",\n \"drive\": \"Rear\",\n \"engineInfo\": \"5.6L L4 DOHC 32V\",\n \"transmission\": \"Automatic\",\n \"antilockBrakes\": true,\n \"daytimeRunningLights\": true,\n \"tonRating\": \"Unknown\",\n \"passiveRestraints\": \"AirbagBothSides\",\n \"country\": \"United States\",\n \"ownershipType\": \"Owned\",\n \"vin\": \"JN8AY2ND3H9000000\",\n \"baseListPrice\": 44900,\n \"registeredOwner\": \"Chris Autterson\",\n \"vehiclePurchaseDate\": \"2020-05-18T00:00:00\",\n \"price\": -1,\n \"plateNumber\": \"TX2345\",\n \"trim\": \"SV,SL,PLATINUM\",\n \"model\": \"ARMADA SV\",\n \"make\": \"NISSAN\",\n \"year\": 2017,\n \"fuel\": \"Gas\"\n },\n {\n \"bodyStyle\": \"PICKUP 4\",\n \"drive\": \"Rear\",\n \"engineInfo\": \"3.7L L4 OHV \",\n \"transmission\": \"Manual\",\n \"antilockBrakes\": false,\n \"tonRating\": \"1/2\",\n \"passiveRestraints\": \"AirbagBothSides\",\n \"country\": \"United States\",\n \"ownershipType\": \"Owned\",\n \"vin\": \"1D7HA18K98J000000\",\n \"baseListPrice\": 26320,\n \"registeredOwner\": \"Tyrone Westgarth\",\n \"vehiclePurchaseDate\": \"2020-07-27T00:00:00\",\n \"price\": 14200,\n \"plateNumber\": \"TX2346\",\n \"trim\": \"ST\",\n \"model\": \"RAM 1500 ST\",\n \"make\": \"DODGE\",\n \"year\": 2008,\n \"fuel\": \"Gas\"\n }\n ],\n \"drivers\": [\n {\n \"firstName\": \"Chris\",\n \"lastName\": \"Autterson\",\n \"dateOfBirth\": \"1960-09-09T00:00:00\",\n \"driversLicenseState\": \"TX\",\n \"gender\": \"Female\",\n \"maritalStatus\": \"Married\",\n \"verificationDate\": \"2020-03-15T00:00:00\"\n },\n {\n \"firstName\": \"Sheri\",\n \"lastName\": \"Autterson\",\n \"dateOfBirth\": \"1968-08-24T00:00:00\",\n \"driversLicenseState\": \"TX\",\n \"gender\": \"Female\",\n \"maritalStatus\": \"Single\",\n \"verificationDate\": \"2019-02-15T00:00:00\"\n },\n {\n \"firstName\": \"Tyrone\",\n \"lastName\": \"Westgarth\",\n \"middleName\": \"K\",\n \"dateOfBirth\": \"1993-04-10T00:00:00\",\n \"gender\": \"Male\",\n \"maritalStatus\": \"Single\",\n \"verificationDate\": \"2020-01-15T00:00:00\"\n },\n {\n \"firstName\": \"Carissa\",\n \"lastName\": \"Sharma\",\n \"middleName\": \"E\",\n \"dateOfBirth\": \"1983-04-23T00:00:00\",\n \"gender\": \"Female\",\n \"maritalStatus\": \"Single\",\n \"verificationDate\": \"2020-02-15T00:00:00\"\n }\n ]\n}"},{"id":"a3b861cd-bc81-46ca-af09-6885bb911a1b","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"addressType\": 1,\n \"addressLine1\": \"1295 BETTY LANE\",\n \"addressLine2\": \"\",\n \"unit\": \"\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/applicants/21200658?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","applicants","21200658"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"WWW-Authenticate","value":"Bearer"},{"key":"Date","value":"Mon, 12 Feb 2024 19:41:07 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"1dea3691-9ae4-48d4-8cc8-a6937be11144","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"addressType\": 1,\n \"addressLine1\": \"1295 BETTY LANE\",\n \"addressLine2\": \"\",\n \"unit\": \"\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/applicants/21200658?integrationId=1","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","applicants","21200658"],"query":[{"key":"integrationId","value":"1"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 19:42:05 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"c52f790c-de34-46e9-a5f6-706d474f1e1c","name":"Bad Request - Invalid Integration Id","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain","disabled":true}],"body":{"mode":"raw","raw":"{\n \"addressType\": 1,\n \"addressLine1\": \"1295 BETTY LANE\",\n \"addressLine2\": \"\",\n \"unit\": \"\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/applicants/21200658?integrationId=1","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","applicants","21200658"],"query":[{"key":"integrationId","value":"1"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"167"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Mon, 12 Feb 2024 19:52:38 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"82110f2d-2def-4461-8f58-dc467988d91b\",\n \"message\": \"User or organization does not have a valid authentication.\",\n \"isUserFriendlyMessage\": true\n}"},{"id":"89801be5-36f0-4802-adad-4cc3a5c62ecc","name":"Bad Request - Invalid Applicant Id","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain","disabled":true}],"body":{"mode":"raw","raw":"{\n \"addressType\": 1,\n \"addressLine1\": \"1295 BETTY LANE\",\n \"addressLine2\": \"\",\n \"unit\": \"\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/applicants/1?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","applicants","1"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"134"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 19:53:04 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"7b1757bc-385a-403c-b19d-4f44c2b26b54\",\n \"message\": \"Unable to find applicant.\",\n \"isUserFriendlyMessage\": true\n}"},{"id":"ca82ba17-0f85-4cfa-b71b-b3115c1e90f2","name":"Bad Request - Missing Address Line 1","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain","disabled":true}],"body":{"mode":"raw","raw":"{\n \"addressType\": 1,\n\n \"addressLine2\": \"\",\n \"unit\": \"\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/applicants/21200658?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","applicants","21200658"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"319"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 19:53:29 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"AddressLine1\": [\n \"The AddressLine1 field is required.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"e69f89db-46eb-4f63-a02f-f82f745bea64","name":"Bad Request - Address Line 1 > 50 characters","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain","disabled":true}],"body":{"mode":"raw","raw":"{\n \"addressType\": 1,\n \"addressLine1\": \"1295 BETTY LANE 126854798491616541967498794162165498797965163132165498749846131649687498465132134196847\",\n \"addressLine2\": \"\",\n \"unit\": \"\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/applicants/21200658?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","applicants","21200658"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"352"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 19:54:04 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"AddressLine1\": [\n \"The field AddressLine1 must be a string with a maximum length of 50.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"6f556fbb-4309-439b-8b1f-d9edb7cf663a","name":"Bad Request - Address Line 2 > 50 characters","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain","disabled":true}],"body":{"mode":"raw","raw":"{\n \"addressType\": 1,\n \"addressLine1\": \"1295 BETTY LANE\",\n \"addressLine2\": \" 126854798491616541967498794162165498797965163132165498749846131649687498465132134196847\",\n \"unit\": \"\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/applicants/21200658?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","applicants","21200658"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"352"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 19:54:35 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"AddressLine2\": [\n \"The field AddressLine2 must be a string with a maximum length of 50.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"66b1e34b-acec-40b3-8a21-6a1c797d8ac3","name":"Bad Request - Unit > 5 characters","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain","disabled":true}],"body":{"mode":"raw","raw":"{\n \"addressType\": 1,\n \"addressLine1\": \"1295 BETTY LANE\",\n \"addressLine2\": \"\",\n \"unit\": \"123456\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/applicants/21200658?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","applicants","21200658"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"335"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 19:55:05 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"Unit\": [\n \"The field Unit must be a string with a maximum length of 5.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"b0e7a1a9-2fb7-4407-afd6-cdce5047d1ba","name":"Bad Request - Missing Zip Input","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain","disabled":true}],"body":{"mode":"raw","raw":"{\n \"addressType\": 1,\n \"addressLine1\": \"1295 BETTY LANE\",\n \"addressLine2\": \"\",\n \"unit\": \"\",\n\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/applicants/21200658?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","applicants","21200658"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"301"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 19:55:26 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"Zip\": [\n \"The Zip field is required.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"45aee52f-b782-4808-b5d1-9e8fac7b7c44","name":"Bad Request - Zip <> 5 numbers","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain","disabled":true}],"body":{"mode":"raw","raw":"{\n \"addressType\": 1,\n \"addressLine1\": \"1295 BETTY LANE\",\n \"addressLine2\": \"\",\n \"unit\": \"\",\n \"zip\": \"1\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/applicants/21200658?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","applicants","21200658"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"336"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 19:55:46 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"Zip\": [\n \"The field Zip must match the regular expression '^[0-9]{5}$'.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"d1aa0894-7bc0-45d0-98e3-d647d39724c4","name":"Bad Request - Plus4 <> 4 numbers","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain","disabled":true}],"body":{"mode":"raw","raw":"{\n \"addressType\": 1,\n \"addressLine1\": \"1295 BETTY LANE\",\n \"addressLine2\": \"\",\n \"unit\": \"\",\n \"zip\": \"73301\",\n \"plus4\": \"a\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/applicants/21200658?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","applicants","21200658"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"340"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 19:56:17 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"Plus4\": [\n \"The field Plus4 must match the regular expression '^[0-9]{4}$'.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"589c63fc-01de-4fef-98b1-4302654cad62","name":"Bad Request - Missing State Code Input","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain","disabled":true}],"body":{"mode":"raw","raw":"{\n \"addressType\": 1,\n \"addressLine1\": \"1295 BETTY LANE\",\n \"addressLine2\": \"\",\n \"unit\": \"\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/applicants/21200658?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","applicants","21200658"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"313"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 19:57:05 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"StateCode\": [\n \"The StateCode field is required.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"04038576-0261-4446-a96d-886b89e04464","name":"Bad Reqeust - State Code <> 2 characters","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain","disabled":true}],"body":{"mode":"raw","raw":"{\n \"addressType\": 1,\n \"addressLine1\": \"1295 BETTY LANE\",\n \"addressLine2\": \"\",\n \"unit\": \"\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"Texas\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/applicants/21200658?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","applicants","21200658"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"371"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 19:57:25 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"StateCode\": [\n \"The field StateCode must be a string with a minimum length of 2 and a maximum length of 2.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"eccc5694-f466-456c-b81a-9a7605e878b2","name":"Bad Request - County > 50 characters","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain","disabled":true}],"body":{"mode":"raw","raw":"{\n \"addressType\": 1,\n \"addressLine1\": \"1295 BETTY LANE\",\n \"addressLine2\": \"\",\n \"unit\": \"\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis9879879894621261654974987954163216498798461321967498496513216549674986516516987498\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/applicants/21200658?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","applicants","21200658"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"340"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 19:58:00 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"County\": [\n \"The field County must be a string with a maximum length of 50.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"c7669fe7-595c-487a-b7b5-b27e91e94d08","name":"Bad Request - Missing City Input","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain","disabled":true}],"body":{"mode":"raw","raw":"{\n \"addressType\": 1,\n \"addressLine1\": \"1295 BETTY LANE\",\n \"addressLine2\": \"\",\n \"unit\": \"\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/applicants/21200658?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","applicants","21200658"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"303"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 19:58:24 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"City\": [\n \"The City field is required.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"50b7d97c-5dee-4821-93c1-bf6e4ac704e3","name":"Bad Request - City > 30 characters","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain","disabled":true}],"body":{"mode":"raw","raw":"{\n \"addressType\": 1,\n \"addressLine1\": \"1295 BETTY LANE\",\n \"addressLine2\": \"\",\n \"unit\": \"\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin87987987941616321321654987984651\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/applicants/21200658?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","applicants","21200658"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"336"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 19:58:50 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"City\": [\n \"The field City must be a string with a maximum length of 30.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"0d011cbe-f0ad-439a-b763-a481a737d1bb","name":"Bad Request - YearsAtAddress > 15","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain","disabled":true}],"body":{"mode":"raw","raw":"{\n \"addressType\": 1,\n \"addressLine1\": \"1295 BETTY LANE\",\n \"addressLine2\": \"\",\n \"unit\": \"\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 16,\n \"monthsAtAddress\": 0\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/applicants/21200658?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","applicants","21200658"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"336"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 19:59:18 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"YearsAtAddress\": [\n \"The field YearsAtAddress must be between 0 and 15.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"32700aba-9765-4978-a649-4dfb0a57c243","name":"Bad Request - YearsAtAddress < 0","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain","disabled":true}],"body":{"mode":"raw","raw":"{\n \"addressType\": 1,\n \"addressLine1\": \"1295 BETTY LANE\",\n \"addressLine2\": \"\",\n \"unit\": \"\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": -1,\n \"monthsAtAddress\": 0\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/applicants/21200658?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","applicants","21200658"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"336"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 19:59:49 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"YearsAtAddress\": [\n \"The field YearsAtAddress must be between 0 and 15.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"3287145f-7c3b-4373-90f9-2345268f647e","name":"Bad Request - MonthsAtAddress > 11","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain","disabled":true}],"body":{"mode":"raw","raw":"{\n \"addressType\": 1,\n \"addressLine1\": \"1295 BETTY LANE\",\n \"addressLine2\": \"\",\n \"unit\": \"\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 12\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/applicants/21200658?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","applicants","21200658"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"338"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 20:00:18 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"MonthsAtAddress\": [\n \"The field MonthsAtAddress must be between 0 and 11.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"5c6b020b-084c-4062-9e37-eff8a22796f5","name":"Bad Request - MonthsAtAddress < 0","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain","disabled":true}],"body":{"mode":"raw","raw":"{\n \"addressType\": 1,\n \"addressLine1\": \"1295 BETTY LANE\",\n \"addressLine2\": \"\",\n \"unit\": \"\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": -1\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/applicants/21200658?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","applicants","21200658"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"338"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 20:00:38 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"MonthsAtAddress\": [\n \"The field MonthsAtAddress must be between 0 and 11.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"}],"_postman_id":"5ffb086f-8686-46b0-9285-9ebc23ea7925"},{"name":"Search without applicant (vendor)","id":"12e3c91e-6456-47d9-9ea2-dbdc597892b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Chris\",\n \"lastName\": \"Autterson\",\n \"dateOfBirth\": \"11/11/1999\",\n \"address\": {\n \"addressType\": 1,\n \"addressLine1\": \"1295 Betty Lane\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{url}}/RatingApi/v1/auto-lookup/web-services/search?integrationId=9823","description":"
Use: Executes auto lookup without an applicantid
\n
Returns: Returns a lookup model with vehicle details, vehicle enhanced details and Driver's info, based on the integrationId
\n
Notes:
\n
\n
The organization should have Fenris API integration set up to consume the auto-lookup data.
\n
Its required to send in the integrationId in the url.
\n
It's required to send in the First Name, Last Name, Date of Birth and LookupAddress in the body of the request.
\n
\n
Responses and Descriptions:
\n
Responses and Descriptions:
\n
\n
Success:
\n
Returns a 200 OK status code on success.
\n
\n
\n
400 Bad Request- Invalid IntegrationId
\n
Request contains invalid IntegrationId
\n
Send in a valid IntegrationIdto fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- Missing AddressLine 1
\n
Request is missing AddressLine 1
\n
Send in a valid AddressLine 1 to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- AddressLine 1 > 50 characters
\n
Request contains AddressLine 1 which exceeds a maximum length of 50.
\n
Send in a valid AddressLine 1 with a maximum length of 50.
\n
\n
\n
\n
\n
400 Bad Request- AddressLine 2 > 50 characters
\n
Request contains AddressLine 2 which exceeds a maximum length of 50.
\n
Send in a valid AddressLine 2 with a maximum length of 50.
\n
\n
\n
\n
\n
400 Bad Request- Unit > 5 characters
\n
Request contains Unit field that exceeds 5 characters.
\n
Send in a valid Unit field with a maximum length of 5 characters.
\n
\n
\n
\n
\n
400 Bad Request- Missing Zip Input
\n
Request is missing Zip input.
\n
Send in a valid Zip input to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- Zip <> 5 numbers
\n
Request contains a Zip input that doesn't contain 5 characters.
\n
Send in a valid Zip input that contain exactly 5 characters to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- Plus4 <> 4 numbers
\n
Request contains a Plus4 input that doesn't contain 4 characters.
\n
Send in a valid Plus4 Zip input that contain exactly 4 characters to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- Missing State Code Input
\n
Request is missing a State Code input.
\n
Send in a valid State Code input to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- State Code <> 2 numbers
\n
Request contains a State Code input that doesn't contain 2 characters.
\n
Send in a valid State Code input that contain exactly 2 characters to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- County > 50 characters
\n
Request contains County field that exceeds 50 characters.
\n
Send in a valid County field with a maximum length of 50 characters.
\n
\n
\n
\n
\n
400 Bad Request- Missing City Input
\n
Request is missing a City input.
\n
Send in a valid City input to fix the issue.
\n
\n
\n
\n
\n
400 Bad Request- City > 30 characters
\n
Request contains City field that exceeds 30 characters.
\n
Send in a valid City field with a maximum length of 30 characters.
\n
\n
\n
\n
\n
400 Bad Request- Years at Address > 15
\n
Request contains Years at Address field that exceeds 15 characters.
\n
Send in a valid Years at Address field that's between 0-15 characters.
\n
\n
\n
\n
\n
400 Bad Request- Years at Address < 0
\n
Request contains Years at Address field that is less than 0 characters.
\n
Send in a valid Years at Address field that's between 0-15 characters.
\n
\n
\n
\n
\n
400 Bad Request- MonthsAtAddress > 11
\n
Request contains Months at Address field that exceeds 11 characters.
\n
Send in a valid Months at Address field that's between 0-11 characters.
\n
\n
\n
\n
\n
400 Bad Request- MonthsAtAddress < 0
\n
Request contains Months at Address field that is less than 0 characters.
\n
Send in a valid Months at Address field that's between 0-11 characters.
\n
\n
\n
\n
\n
\n","urlObject":{"path":["RatingApi","v1","auto-lookup","web-services","search"],"host":["{{url}}"],"query":[{"key":"integrationId","value":"9823"}],"variable":[]}},"response":[{"id":"60ded56e-951a-4236-bd81-7ba3bc3350e7","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Chris\",\n \"lastName\": \"Autterson\",\n \"dateOfBirth\": \"11/11/1999\",\n \"address\": {\n \"addressType\": 1,\n \"addressLine1\": \"1295 Betty Lane\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/search?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","search"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"br"},{"key":"Vary","value":"Accept-Encoding"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Mon, 22 Jan 2024 22:18:16 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"vehicles\": [\n {\n \"model\": \"QUEST\",\n \"make\": \"NISSAN\",\n \"year\": 2012,\n \"fuel\": \"Gas\",\n \"vehicleType\": \"Van\"\n },\n {\n \"model\": \"CAMRY\",\n \"make\": \"TOYOTA\",\n \"year\": 2011,\n \"fuel\": \"Gas\",\n \"vehicleType\": \"Sedan\"\n },\n {\n \"model\": \"ALTIMA\",\n \"make\": \"NISSAN\",\n \"year\": 2006,\n \"fuel\": \"Gas\",\n \"vehicleType\": \"Sedan\"\n }\n ],\n \"vehiclesEnhanced\": [\n {\n \"bodyStyle\": \"SPORT UTILITY VEHICLE 4\",\n \"drive\": \"Rear\",\n \"engineInfo\": \"5.6L L4 DOHC 32V\",\n \"transmission\": \"Automatic\",\n \"antilockBrakes\": true,\n \"daytimeRunningLights\": true,\n \"tonRating\": \"Unknown\",\n \"passiveRestraints\": \"AirbagBothSides\",\n \"country\": \"United States\",\n \"ownershipType\": \"Owned\",\n \"vin\": \"JN8AY2ND3H9000000\",\n \"baseListPrice\": 44900,\n \"registeredOwner\": \"Chris Autterson\",\n \"vehiclePurchaseDate\": \"2020-05-18T00:00:00\",\n \"price\": -1,\n \"plateNumber\": \"TX2345\",\n \"trim\": \"SV,SL,PLATINUM\",\n \"model\": \"ARMADA SV\",\n \"make\": \"NISSAN\",\n \"year\": 2017,\n \"fuel\": \"Gas\"\n },\n {\n \"bodyStyle\": \"PICKUP 4\",\n \"drive\": \"Rear\",\n \"engineInfo\": \"3.7L L4 OHV \",\n \"transmission\": \"Manual\",\n \"antilockBrakes\": false,\n \"tonRating\": \"1/2\",\n \"passiveRestraints\": \"AirbagBothSides\",\n \"country\": \"United States\",\n \"ownershipType\": \"Owned\",\n \"vin\": \"1D7HA18K98J000000\",\n \"baseListPrice\": 26320,\n \"registeredOwner\": \"Tyrone Westgarth\",\n \"vehiclePurchaseDate\": \"2020-07-27T00:00:00\",\n \"price\": 14200,\n \"plateNumber\": \"TX2346\",\n \"trim\": \"ST\",\n \"model\": \"RAM 1500 ST\",\n \"make\": \"DODGE\",\n \"year\": 2008,\n \"fuel\": \"Gas\"\n }\n ],\n \"drivers\": [\n {\n \"firstName\": \"Chris\",\n \"lastName\": \"Autterson\",\n \"dateOfBirth\": \"1999-11-11T00:00:00\",\n \"driversLicenseState\": \"TX\",\n \"gender\": \"Female\",\n \"maritalStatus\": \"Married\",\n \"verificationDate\": \"2020-03-15T00:00:00\"\n },\n {\n \"firstName\": \"Sheri\",\n \"lastName\": \"Autterson\",\n \"dateOfBirth\": \"1968-08-24T00:00:00\",\n \"driversLicenseState\": \"TX\",\n \"gender\": \"Female\",\n \"maritalStatus\": \"Single\",\n \"verificationDate\": \"2019-02-15T00:00:00\"\n },\n {\n \"firstName\": \"Tyrone\",\n \"lastName\": \"Westgarth\",\n \"middleName\": \"K\",\n \"dateOfBirth\": \"1993-04-10T00:00:00\",\n \"gender\": \"Male\",\n \"maritalStatus\": \"Single\",\n \"verificationDate\": \"2020-01-15T00:00:00\"\n },\n {\n \"firstName\": \"Carissa\",\n \"lastName\": \"Sharma\",\n \"middleName\": \"E\",\n \"dateOfBirth\": \"1983-04-23T00:00:00\",\n \"gender\": \"Female\",\n \"maritalStatus\": \"Single\",\n \"verificationDate\": \"2020-02-15T00:00:00\"\n }\n ]\n}"},{"id":"6165b5bb-cc64-4cdb-8ad2-0e4d7b7b899b","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Chris\",\n \"lastName\": \"Autterson\",\n \"dateOfBirth\": \"11/11/1999\",\n \"address\": {\n \"addressType\": 1,\n \"addressLine1\": \"1295 Betty Lane\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/search?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","search"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"WWW-Authenticate","value":"Bearer"},{"key":"Date","value":"Mon, 12 Feb 2024 20:01:47 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"fd45ea32-f09e-4174-8e96-79e36893b073","name":"Bad Request - Invalid Integration Id","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Chris\",\n \"lastName\": \"Autterson\",\n \"dateOfBirth\": \"11/11/1999\",\n \"address\": {\n \"addressType\": 1,\n \"addressLine1\": \"1295 Betty Lane\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/search?integrationId=1","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","search"],"query":[{"key":"integrationId","value":"1"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"167"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Mon, 12 Feb 2024 20:02:18 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"3b90bcda-b84c-4ac3-9605-6b96e16dbe07\",\n \"message\": \"User or organization does not have a valid authentication.\",\n \"isUserFriendlyMessage\": true\n}"},{"id":"f20288b9-4807-440b-bf44-452fdb787c80","name":"Bad Request - Missing Address Line 1","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Chris\",\n \"lastName\": \"Autterson\",\n \"dateOfBirth\": \"11/11/1999\",\n \"address\": {\n \"addressType\": 1,\n\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/search?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","search"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"327"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 20:03:46 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"Address.AddressLine1\": [\n \"The AddressLine1 field is required.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"d628d4b3-9aa8-4186-b986-f6a7e6c6efa9","name":"Bad Request - AddressLine1 > 50 characters","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Chris\",\n \"lastName\": \"Autterson\",\n \"dateOfBirth\": \"11/11/1999\",\n \"address\": {\n \"addressType\": 1,\n \"addressLine1\": \"1295 Betty Lane79896461321326549879896465132132132165498798989654631651654987\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/search?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","search"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"360"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 20:04:19 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"Address.AddressLine1\": [\n \"The field AddressLine1 must be a string with a maximum length of 50.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"8c704c94-fd73-46ff-905a-2c3364eec740","name":"Bad Request - AddressLine2 > 50 characters","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Chris\",\n \"lastName\": \"Autterson\",\n \"dateOfBirth\": \"11/11/1999\",\n \"address\": {\n \"addressType\": 1,\n \"addressLine1\": \"1295 Betty Lane\",\n \"addressLine2\": \"79896461321326549879896465132132132165498798989654631651654987\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/search?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","search"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"360"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 20:05:04 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"Address.AddressLine2\": [\n \"The field AddressLine2 must be a string with a maximum length of 50.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"632ce3bf-5506-47d3-951c-d5f9ac2f8917","name":"Bad Request - Unit > 5 characters","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Chris\",\n \"lastName\": \"Autterson\",\n \"dateOfBirth\": \"11/11/1999\",\n \"address\": {\n \"addressType\": 1,\n \"addressLine1\": \"1295 Betty Lane\",\n \"Unit\": \"asdfsadf\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/search?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","search"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"343"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 20:05:38 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"Address.Unit\": [\n \"The field Unit must be a string with a maximum length of 5.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"afc0e32b-a29b-4fda-8ccd-2faabf7ff874","name":"Bad Request - Missing Zip Input","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Chris\",\n \"lastName\": \"Autterson\",\n \"dateOfBirth\": \"11/11/1999\",\n \"address\": {\n \"addressType\": 1,\n \"addressLine1\": \"1295 Betty Lane\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/search?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","search"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"309"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 20:06:02 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"Address.Zip\": [\n \"The Zip field is required.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"4732f4b1-86f1-4c44-a24b-75c48605565d","name":"Bad Request - Zip <> 5 numbers","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Chris\",\n \"lastName\": \"Autterson\",\n \"dateOfBirth\": \"11/11/1999\",\n \"address\": {\n \"addressType\": 1,\n \"addressLine1\": \"1295 Betty Lane\",\n \"zip\": \"a\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/search?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","search"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"344"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 20:06:21 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"Address.Zip\": [\n \"The field Zip must match the regular expression '^[0-9]{5}$'.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"2c03d1e1-6295-4960-bad9-633d7353aea8","name":"Bad Request - Unit <> 4 numbers","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Chris\",\n \"lastName\": \"Autterson\",\n \"dateOfBirth\": \"11/11/1999\",\n \"address\": {\n \"addressType\": 1,\n \"addressLine1\": \"1295 Betty Lane\",\n \"zip\": \"73301\",\n \"plus4\": \"a\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/search?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","search"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"348"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 20:06:50 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"Address.Plus4\": [\n \"The field Plus4 must match the regular expression '^[0-9]{4}$'.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"75835032-af07-4ac1-bb7d-f68fecef311f","name":"Bad Request - Missing State Code Input","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Chris\",\n \"lastName\": \"Autterson\",\n \"dateOfBirth\": \"11/11/1999\",\n \"address\": {\n \"addressType\": 1,\n \"addressLine1\": \"1295 Betty Lane\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/search?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","search"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"321"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 20:07:15 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"Address.StateCode\": [\n \"The StateCode field is required.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"6805d969-1e0a-4aca-bbe2-5aab93437d36","name":"Bad Request - StateCode <> 2 characters","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Chris\",\n \"lastName\": \"Autterson\",\n \"dateOfBirth\": \"11/11/1999\",\n \"address\": {\n \"addressType\": 1,\n \"addressLine1\": \"1295 Betty Lane\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"Texas\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/search?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","search"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"379"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 20:07:40 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"Address.StateCode\": [\n \"The field StateCode must be a string with a minimum length of 2 and a maximum length of 2.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"f1b140e1-70cf-4003-a240-a92532db771d","name":"Bad Request - County > 50 characters","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Chris\",\n \"lastName\": \"Autterson\",\n \"dateOfBirth\": \"11/11/1999\",\n \"address\": {\n \"addressType\": 1,\n \"addressLine1\": \"1295 Betty Lane\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis879846516749896416352165498798798465163165498798\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/search?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","search"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"348"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 20:08:08 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"Address.County\": [\n \"The field County must be a string with a maximum length of 50.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"0ebd44e5-87f8-4521-8332-0890ce08b9b7","name":"Bad Request - Missing City Input","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Chris\",\n \"lastName\": \"Autterson\",\n \"dateOfBirth\": \"11/11/1999\",\n \"address\": {\n \"addressType\": 1,\n \"addressLine1\": \"1295 Betty Lane\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/search?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","search"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"311"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 20:08:47 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"Address.City\": [\n \"The City field is required.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"4e00f970-7b3c-49c6-b71f-9a6340e1efb1","name":"Bad Request - City > 30 characters","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Chris\",\n \"lastName\": \"Autterson\",\n \"dateOfBirth\": \"11/11/1999\",\n \"address\": {\n \"addressType\": 1,\n \"addressLine1\": \"1295 Betty Lane\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin8979894316569547987984652163216549874984\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 0\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/search?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","search"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"344"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 20:09:10 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"Address.City\": [\n \"The field City must be a string with a maximum length of 30.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"37ab3072-bce0-422d-b149-9d215c0f0006","name":"Bad Request - YearsAtAddress > 15","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Chris\",\n \"lastName\": \"Autterson\",\n \"dateOfBirth\": \"11/11/1999\",\n \"address\": {\n \"addressType\": 1,\n \"addressLine1\": \"1295 Betty Lane\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 16,\n \"monthsAtAddress\": 0\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/search?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","search"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"344"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 20:09:44 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"Address.YearsAtAddress\": [\n \"The field YearsAtAddress must be between 0 and 15.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"8e0bdfc7-3659-4b4a-8b78-0817bc47cfae","name":"Bad Request - YearsAtAddress < 0","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Chris\",\n \"lastName\": \"Autterson\",\n \"dateOfBirth\": \"11/11/1999\",\n \"address\": {\n \"addressType\": 1,\n \"addressLine1\": \"1295 Betty Lane\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": -1,\n \"monthsAtAddress\": 0\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/search?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","search"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"344"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 20:10:12 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"Address.YearsAtAddress\": [\n \"The field YearsAtAddress must be between 0 and 15.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"875c63ca-050e-487e-a33c-4f5003a3b479","name":"Bad Request - MonthsAtAddress > 11","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Chris\",\n \"lastName\": \"Autterson\",\n \"dateOfBirth\": \"11/11/1999\",\n \"address\": {\n \"addressType\": 1,\n \"addressLine1\": \"1295 Betty Lane\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": 12\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/search?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","search"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"346"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 20:10:30 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"Address.MonthsAtAddress\": [\n \"The field MonthsAtAddress must be between 0 and 11.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"},{"id":"25dfdb44-5299-48ba-bd95-e80121dcda3b","name":"Bad Request - MonthsAtAddress > 0","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Chris\",\n \"lastName\": \"Autterson\",\n \"dateOfBirth\": \"11/11/1999\",\n \"address\": {\n \"addressType\": 1,\n \"addressLine1\": \"1295 Betty Lane\",\n \"zip\": \"73301\",\n \"plus4\": \"0001\",\n \"stateCode\": \"TX\",\n \"county\": \"Travis\",\n \"city\": \"Austin\",\n \"yearsAtAddress\": 0,\n \"monthsAtAddress\": -1\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{url}}/RatingApi/v1/auto-lookup/web-services/search?integrationId=9823","host":["{{url}}"],"path":["RatingApi","v1","auto-lookup","web-services","search"],"query":[{"key":"integrationId","value":"9823"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"346"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 20:10:48 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"00000000-0000-0000-0000-000000000000\",\n \"message\": \"Model Validation Error\",\n \"modelState\": {\n \"errors\": {\n \"Address.MonthsAtAddress\": [\n \"The field MonthsAtAddress must be between 0 and 11.\"\n ]\n },\n \"title\": \"One or more validation errors occurred.\"\n },\n \"isUserFriendlyMessage\": false\n}"}],"_postman_id":"12e3c91e-6456-47d9-9ea2-dbdc597892b5"}],"id":"d4d7bf55-b8e9-40a0-87af-260f510d6576","_postman_id":"d4d7bf55-b8e9-40a0-87af-260f510d6576","description":""}],"id":"3b81a3a7-4443-4e98-a54d-9f7b041f0e2e","description":"
The 2 distinct functionalities of the Auto-Lookup endpoints are the following:
\n\n
Execute auto-lookup by applicantId.
\n
Execute auto-lookup up by integrationId when there is no applicantId provided.
\n\n
Prerequisite: It’s required that the 3rd party organization that owns the Vendor Data Access client should have the Fenris API integration set up to consume the auto-lookup data.
\n
It’s important to note that we’re using the Fenris credentials associated with the 3rd party organization and are not using the target user’s organization's Fenris credentials. Hence, the Fenris integration should be added to the organization itself and the organization should make sure that the integration is enabled for them.
\n
A Connect Admin can enable the integration in EZLynx if the 3rd party organization doesn’t have it configured.
\n
We have the Fenris integration set up for all major environments and the integrationId has specific static values for each environment as follows:
The 2 distinct functionalities of EZAuto endpoints are the following:
\n\n
Create, get or update an applicant along with Auto application data, using the Applicant API.
\n
\n
Create or update an applicant along with Auto application data AND simultaneously submit quote, using the Rating API.
\n
\n\n
Please note that an applicant can be created with or without XrefKey in both scenarios.
\n
The EZAuto workflow is as follows:
\n
Authenticate:
\n
\n
Get a token via our POST {{EzLynxIdentityUrl}}connect/token endpoint.
\n
\n
This should be set as an authorization header for the bearer (OAuth) token in the environment for the subsequent calls (Refer to the 'Authenticate' section for more information).
\n
\n
\n
Once authenticated, user can utilize our API endpoints to either create a new applicant with Auto application or submit quote and simultaneously create an applicant with Auto application as follows:
\n
Create a new applicant with Auto application:
\n
Required scopes: openid ApplicantApi
\n
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/applicants/auto to create a new applicant with Auto application. This returns an applicantId and applicant details URL. OR
\n
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/applicants/auto?xrefKey={{Xref_key}} to create a new applicant with an XrefKey and create Auto application. This returns an applicantId and applicant details URL.
\n
\n
\n
Get Auto Application Details
\n
Required scopes: openid ApplicantApi
\n
Once an applicant is created with an auto application, users can get that application data, using the GET endpoints as follows:
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/:applicantId/auto to get application details by applicantId. OR
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/auto?xrefKey={{Xref_key}} and pass the XrefKey to get application details by XrefKey.
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/:applicantId/auto/acord to get an Auto application by applicantId in ACORD format.
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/auto/acord?xrefKey={{Xref_key}} and pass the XrefKey to get application details by XrefKey in ACORD format.
\n
\n
\n
Notes: The EZAuto GET endpoints are used to get Auto application details associated with Applicants. This endpoint will not return other applications such as Home or DwellingFire even if the applicant has those applications. In order to get the Home or DwellingFire applications, you can use endpoints belonging to their respective LOBs.
\n
Update Applicant and Auto Application Details
\n
Required scopes: openid ApplicantApi
\n
Users can utilize the EZAuto PUT endpoints to update an existing applicant and create or update Auto application details.
\n
\n
Make a request to PUT {{Url}}/ApplicantApi/web-services/v1/applicants/{{applicant_Id}}/auto to update an existing applicant and Auto application details by applicantId. This returns the applicantId of the updated applicant and applicant details URL. OR
\n
\n
Make a request to PUT {{Url}}/ApplicantApi/web-services/v1/applicants/auto?xrefKey={{Xref_key}} to update an existing applicant and Auto application details by XrefKey. This returns the applicantId of the updated applicant and applicant details URL.
\n
\n
\n
Please note that when an applicant is created with Auto application details, users can replace it with the new application details using the EZAuto PUT endpoints. Also, if there are no existing auto application details, the EZAuto PUT endpoints can be used to create one.
\n
An applicant can be created with different LOBs like Auto, Home and Dwelling Fire application details. If an applicant is created with a specific LOB application detail, that applicant can be updated to add another LOB application details to it, if required.
\n
VIN Validation
\n
It’s a recommended practice to validate VIN before submitting a quote. Users can utilize the VIN Validation endpoints for the following:
\n
Send Full VIN
\n
Required scopes: openid ApplicantApi
\n
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/auto/metadata/vin endpoint to send in the full VIN to obtain vehicle data. This returns vehicle data for exact or closest matches.
\n
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/auto/metadata/vin-dest endpoint to send in a full VIN to obtain vehicle data with location. This returns vehicle data for exact or closest matches with a location indicator appended to each item for the provided VIN.
\n
\n
\n
If a full VIN is not available, a partial VIN can be used to obtain vehicle data. In order to obtain a partial VIN, send in the Year, Make, and Model of a vehicle in the GET Auto Submodels endpoint and the call response will provide a partial VIN which can be included in the EZAuto application.
\n
GET Vehicle Year/Make/Model
\n
Required scopes: openid ApplicantApi
\n
\n
Make a request to GET Auto Years endpoint (GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/years) to get the Year of a vehicle. This returns a list of years for vehicles (ranges from 1966-2024).
\n
\n
Make a request to GET Auto Make endpoint (GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/makes?year=2021)and send in a valid Year obtained from the previous step to get the Make of the vehicle. This returns a list of auto manufacturers.
\n
\n
Make a request to GET Auto Models’ endpoint (GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/models?year=2021&make=ford) and send in a valid Year and Make obtained from the previous steps to get the Model for the vehicle. This returns a list of auto models based on the Year and Make provided.
\n
\n
\n
GET Auto Sub-Models
\n
Required scopes: openid ApplicantApi
\n
\n
Make a request to GET Auto Submodels endpoint (GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models?year=2021&make=ford&model=BRONCO BASE) to get the auto submodel of a vehicle including a partial VIN. This returns a list of submodels with VIN, Body Style, Drive, Engine, Fuel and Transmission details.
\n
\n
Make a request to GET Auto Submodels All endpoint (GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/all?year=2021&make=ford&model=BRONCO BASE) to get an unfiltered list of submodels with partial VIN.
\n
\n
Make a request to GET Auto Submodels (Masked VIN) endpoint (GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/mask-vin?year=2021&make=ford&model=BRONCO BASE) to get the auto submodel of a vehicle with masked partial VIN. This returns the same result as GET Auto Submodels endpoint except that VINs will be masked.
\n
\n
Make a request to GET Auto Submodels (With Location) endpoint (GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/include-locations?year=2015&make=AUDI&model=A7 TECHNIK). This returns the same result as GET Auto Submodels endpoint except that a Location Indicator will be appended to each item and partial VINs will be masked.
\n
\n
\n
Apart from creating an applicant and Auto application using the Applicant API, the users can also create an applicant with Auto application data and submit quote simultaneously using the following Rating API endpoints as follows:
\n
Submit Quote and create a new applicant with Auto application
\n
Required scopes: openid RatingApi QAS
\n
Our APIs can be utilized to submit quote and create applicant with Auto application as follows:
\n
\n
Make a request to POST {{Url}}/RatingApi/web-services/v1/quotes/auto to submit quote and create an applicant and Auto application. This returns an applicantId and quoteExecutionId. OR
\n
\n
Make a request to POST {{Url}}/RatingApi/web-services/v1/quotes/auto?xrefKey={{Xref_key}} to submit quote and create an applicant with Xref and create Auto application. This returns an applicantId and quoteExecutionId
\n
\n
\n
Submit Auto Quote and update Applicant with Auto Application data
\n
Required scopes: openid RatingApi QAS
\n
Users can utilize the EZAuto PUT endpoints to submit Auto Quote and update Applicant with Auto Application data.
\n
\n
Make a request to PUT {{Url}}/RatingApi/web-services/v1/quotes/applicants/{{applicant_Id}}/auto to submit Auto Quote and update Applicant with Auto Application data by applicantId. This returns the applicantId and quoteExecutionId . OR
\n
\n
Make a request to PUT {{Url}}/RatingApi/web-services/v1/quotes/auto?xrefKey={{Xref_key}} to submit Auto Quote and update Applicant with Auto Application data by XrefKey. This returns the applicantId and quoteExecutionId
The 2 distinct functionalities of EZHome endpoints are the following:
\n\n
Create, get or update an applicant along with Home application data, using the Applicant API.
\n
\n
Create or update an applicant along with Home application data AND simultaneously submit quote, using the Rating API.
\n
\n\n
Please note that an applicant can be created with or without XrefKey in both scenarios.
\n
The EZHome workflow is as follows:
\n
Authenticate:
\n
\n
Get a token via our POST {{EzLynxIdentityUrl}}connect/token endpoint.
\n
\n
This should be set as an authorization header for the bearer (OAuth) token in the environment for the subsequent calls (Refer 'Authenticate' section for more information).
\n
\n
\n
Once authenticated, user can utilize our API endpoints to either create a new applicant with Home application or submit quote and create an applicant with Home Application as follows:
\n
Create a new applicant with Home Application:
\n
Required scopes: openid ApplicantApi
\n
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/applicants/home to create a new applicant and Home application data. This returns an applicantId and applicant details URL. OR
\n
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/applicants/home?xrefKey={{Xref_key}} to create a new applicant with an XrefKey and Home application data. This returns an applicantId and applicant details URL.
\n
\n
\n
Get Home application details:
\n
Required scopes: openid ApplicantApi
\n
Once an applicant is created with Home application, users can get that application details using the GET endpoints as follows:
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants//home and pass the applicantId to get application details by applicantId. OR
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/home?xrefKey={{Xref_key}} and pass the XrefKey to get application details by XrefKey.
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/20750670/home/acord to get application details by applicantId in ACORD format.
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/home/acord?xrefKey={{Xref_key}} to get application details by XrefKey in ACORD format.
\n
\n
\n
Notes: The EZHome GET endpoints are used to get Home application details associated with Applicants. This endpoint will not return other applications such as Auto or DwellingFire even if the applicant has those applications. In order to get the Auto or DwellingFire applications, you can use endpoints belonging to their respective LOBs.
\n
Update Applicant and Home Application Details
\n
Required scopes: openid ApplicantApi
\n
Users can utilize the EZHome PUT endpoints to update an existing applicant and create or update Home application details as follows:
\n
\n
Make a request to PUT {{Url}}/ApplicantApi/web-services/v1/applicants//home to update an existing applicant and Home application details by applicantId. This returns the applicantId of the updated applicant and applicant details URL. OR
\n
\n
Make a request to PUT {{Url}}/ApplicantApi/web-services/v1/applicants/home?xrefKey={{Xref_key}} to update an existing applicant and Home application details by XrefKey. This returns the applicantId of the updated applicant and applicant details URL.
\n
\n
\n
Please note that when an applicant is created with Home application details, users can replace it with the new application details using the EZHome PUT endpoints. Also, if there are no existing Home application details, the PUT endpoints can be used to create one.
\n
An applicant can be created with different LOBs like Auto, Home and Dwelling Fire application details. If an applicant is created with a specific LOB application detail, that applicant can be updated to add another LOB application details to it, if required.
\n
Apart from creating an applicant and Home application (as described above), the users can also create an applicant with Home application data and submit quote simultaneously using the following Rating API endpoints as follows:
\n
Submit Quote and create a new applicant with Home application
\n
Required scopes: openid RatingApi QAS
\n
Our APIs can be utilized to submit quote and create applicant with Home application as follows:
\n
\n
Make a request to POST {{Url}}/RatingApi/web-services/v1/quotes/home to submit quote and create an applicant and Home application. This returns an applicantId and quoteExecutionId. OR
\n
\n
Make a request to POST {{Url}}/RatingApi/web-services/v1/quotes/home?xrefKey={{Xref_key}} to submit quote and create an applicant with Xref and create Home application. This returns an applicantId and quoteExecutionId
\n
\n
\n
Submit Quote and update Applicant with Home Application data
\n
Required scopes: openid RatingApi QAS
\n
Users can utilize the EZHome PUT endpoints to submit Home Quote and update Applicant with Home Application data as follows:
\n
\n
Make a request to PUT {{Url}}/RatingApi/web-services/v1/quotes/applicants//home to submit Home Quote and update applicant with Home application data by applicantId. This returns the applicantId and quoteExecutionId
\n
\n
Make a request to PUT {{Url}}/RatingApi/web-services/v1/quotes/home?xrefKey={{Xref_key}} to submit Home Quote and update applicant with Home application data by XrefKey. This returns an applicantId and quoteExecutionId
The 2 distinct functionalities of EZDwellingFire endpoints are the following:
\n\n
Create, get or update an applicant along with Dwelling Fire application data, using the Applicant API.
\n
Create or update an applicant along with Dwelling Fire application data AND simultaneously submit quote, using the Rating API.
\n\n
Please note that an applicant can be created with or without XrefKey in both scenarios.
\n
The EZDwellingFire workflow is as follows:
\n
Authenticate:
\n
\n
Get a token via our POST {{EzLynxIdentityUrl}}connect/token endpoint.
\n
This should be set as an authorization header for the bearer (OAuth) token in the environment for the subsequent calls(Refer 'Authenticate' section for more information).
\n
\n
Once authenticated, user can utilize our API endpoints to either create a new applicant with Dwelling Fire application or submit quote and create an applicant with Dwelling Fire Application as follows:
\n
Create a new applicant with Dwelling Fire Application
\n
Required scopes: openid ApplicantApi
\n
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/applicants/dwelling-fire to create a new applicant and Dwelling Fire application data. This returns an applicantId and applicant details URL. OR
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/applicants/dwelling-fire?xrefKey={{Xref_key}} to create a new applicant with an XrefKey and Dwelling Fire application data. This returns an applicantId and applicant details URL.
\n
\n
Get Dwelling Fire Applicant Details
\n
Required scopes: openid ApplicantApi
\n
Once a new Dwelling Fire applicant is created, you can get the applicant details or update the applicant as follows:
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants//dwelling-fire to get application details by applicantId. OR
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/dwelling-fire?xrefKey={{Xref_key}} and pass the XrefKey to get application details by XrefKey.
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/20750670/dwelling-fire/acord to get application details by applicantId in ACORD format. OR
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/dwelling-fire/acord?xrefKey=to get application details by XrefKey in ACORD format.
\n
\n
Notes: The EZDwellingFire GET endpoints are used to get DwellingFire application details associated with Applicants. This endpoint will not return other applications such as Auto or Home even if the applicant has those applications. In order to get the Auto or Home applications, you can use endpoints belonging to their respective LOBs.
\n
Update Applicant and Dwelling Fire Application Details
\n
Required scopes: openid ApplicantApi
\n
Users can utilize the EZDwellingFire PUT endpoints to update an existing applicant and create or update Dwelling Fire application details as follows:
\n
\n
Make a request to PUT {{Url}}/ApplicantApi/web-services/v1/applicants//dwelling-fire to update an existing applicant and Dwelling Fire application details by applicantId. This returns an applicantId and applicant details URL. OR
\n
Make a request to PUT {{Url}}/ApplicantApi/web-services/v1/applicants/dwelling-fire?xrefKey={{Xref_key}} to update an existing applicant and Dwelling Fire application details by XrefKey. This Returns an applicantId of the updated applicant and applicant details URL.
\n
\n
Please note that when an applicant is created with Dwelling Fire application details, users can replace it with the new application details using the EZDwellingFire PUT endpoints. Also, if there are no existing Dwelling Fire application details, the PUT endpoints can be used to create one.
\n
An applicant can be created with different LOBs like Auto, Home and Dwelling Fire application details. If an applicant is created with a specific LOB application detail, that applicant can be updated to add another LOB application details to it, if required.
\n
Apart from creating an applicant and Dwelling Fire application (as described above), the users can also create an applicant with Dwelling Fire application and submit quote simultaneously using the following Rating API endpoints as follows:
\n
Submit Quote and create a new applicant with Dwelling Fire application
\n
Required scopes: openid RatingApi QAS
\n
Our APIs can be utilized to submit quote and create applicant with Dwelling Fire application as follows:
\n
\n
Make a request to POST {{Url}}/RatingApi/web-services/v1/quotes/dwelling-fire to submit quote and create an applicant and Dwelling Fire application. This returns an applicantId and quoteExecutionId. OR
\n
Make a request to POST {{Url}}/RatingApi/web-services/v1/quotes/dwelling-fire?xrefKey={{Xref_key}} to submit quote and create an applicant with Xref and create Dwelling Fire application. This returns an applicantId and quoteExecutionId
\n
\n
Submit Quote and update Applicant with Dwelling Fire Application data
\n
Required scopes: openid RatingApi QAS
\n
Users can utilize the EZDwellingFire PUT endpoints to submit Dwelling Fire Quote and update Applicant with Dwelling Fire Application data as follows:
\n
\n
Make a request to PUT {{Url}}/RatingApi/web-services/v1/quotes/applicants//dwelling-fire to submit Dwelling Fire Quote and update applicant with Dwelling Fire application data by applicantId. This returns an applicantId and quoteExecutionId
\n
Make a request to PUT {{Url}}/RatingApi/web-services/v1/quotes/dwelling-fire?xrefKey={{Xref_key}} to submit Dwelling Fire Quote and update applicant with Dwelling Fire application data by XrefKey. This returns an applicantId and quoteExecutionId
\n
\n","_postman_id":"900b4917-1d6f-4595-893c-83a38669f086"},{"name":"Non-LOB Specific Endpoints","item":[{"name":"Xref Key Copy","item":[{"name":"Assign Xref","event":[{"listen":"prerequest","script":{"id":"e92ac6a9-5b9f-450f-af0f-5cf92341e579","exec":["pm.collectionVariables.set(\"xref_key\", pm.variables.replaceIn(\"0e5ea2fc-9dfe-44b8-aa47-f5c962ed57da\"));"],"type":"text/javascript"}},{"listen":"test","script":{"id":"493795dc-2c6a-4699-8f36-f3686b32416d","exec":[""],"type":"text/javascript"}}],"id":"d725c245-2156-4d33-86db-659d0b38a7d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey","description":"
Use: Assigns an XrefKey to an existing applicant, if that applicant is created without an XrefKey.
\n
Returns: Returns a 200 OK response on success. Please note that an applicant can be associated with only one Xrefkey. Hence, if the applicant is already created with an XrefKey, the user cannot assign a new Xref to that applicant and this request will return a 400 Bad Request Error message.
\n
NOTE: In order to change an existing XrefKey associated with an applicant, the user can utilize the Delete Xref endpoint to delete the existing Xrefkey first, and then use the PUT Assign Xref endpoint to assign a new XrefKey to that applicant.
\n
Responses and Descriptions:
\n
\n
Success:
\n
Returns a 200 OK status code on success.
\n
\n
\n
400 Bad Request- Duplicate xRefKey:
\n
The xRefKey sent in the request is already in use by an existing applicant.
\n","type":"text/plain"},"type":"any","value":"","key":"applicantId"}]}},"response":[{"id":"fe77c923-769c-4779-8929-ee1d0d57c30a","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","applicants",":applicantId","xrefkey"],"variable":[{"key":"applicantId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Mon, 31 Jul 2023 14:15:39 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"6c291243-228b-49c5-a574-571a674e6ef0","name":"Not Found","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ApplicantApi/web-services/v1/applicants/1234875410/xrefkey"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"137"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Wed, 06 Sep 2023 16:44:36 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"cb936bdd-3776-425b-a9a0-37a69cab7311\",\n \"message\": \"The applicant was not found.\",\n \"isUserFriendlyMessage\": true\n}"},{"id":"b7533335-3e03-4bc8-ab22-1fee80426c40","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","applicants",":applicantId","xrefkey"],"variable":[{"key":"applicantId","value":"","description":"The ID of the Applicant"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"WWW-Authenticate","value":"Bearer error=\"invalid_token\", error_description=\"The token expired at '09/06/2023 16:25:02'\""},{"key":"Date","value":"Wed, 06 Sep 2023 16:41:49 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"61232a23-d527-4d5d-86ab-9ced48689fd4","name":"Forbidden","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ApplicantApi/web-services/v1/applicants/1234/xrefkey"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"163"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Wed, 06 Sep 2023 16:44:07 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"93b80df1-cc7a-4c08-9a9a-32c4a0067e4a\",\n \"message\": \"User does not have permission to perform this request.\",\n \"isUserFriendlyMessage\": true\n}"},{"id":"75ffdd65-0a67-44f6-9bf0-a43de032a8ef","name":"Bad Request - Duplicate xrefKey","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","applicants",":applicantId","xrefkey"],"variable":[{"key":"applicantId","value":"","description":"The ID of the Applicant"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"380"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Mon, 12 Feb 2024 15:18:39 GMT"}],"cookie":[],"responseTime":null,"body":"\n 90bbf02e-b67b-4340-be7d-53a6adb0883e\n The xrefKey is already in use or the applicant already has an xrefKey.\n BadRequest\n true\n"}],"_postman_id":"d725c245-2156-4d33-86db-659d0b38a7d0"},{"name":"Delete Xref","id":"b90afe1c-91fb-4cc9-84a2-68fd092bcc7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey","description":"
Use: Deletes an existing XrefKey associated with an applicant.
\n
Returns: Returns a 200 OK response on success.
\n
NOTE: Once an existing XrefKey is deleted, users can utilize the PUT Assign Xref endpoint to assign a new XrefKey to that applicant, if required.
\n
Responses and Descriptions:
\n
\n
Success:
\n
Returns a 200 OK status code on success.
\n
\n
\n
\n","urlObject":{"path":["ApplicantApi","web-services","v1","applicants",":applicantId","xrefkey"],"host":["{{url}}"],"query":[],"variable":[{"id":"eb715245-866c-471b-8273-64cf67bb92e6","type":"any","value":"","key":"applicantId"}]}},"response":[{"id":"cf710b8f-eb85-413d-af87-98a09ab38307","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","applicants",":applicantId","xrefkey"],"variable":[{"key":"applicantId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Mon, 31 Jul 2023 14:15:55 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"01fbdcfe-cba2-4f3f-b564-ccf214bf79b0","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ApplicantApi/web-services/v1/applicants/1234086586/xrefkey"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"137"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Wed, 06 Sep 2023 16:46:11 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"6c515d37-e34d-4c1e-9987-6f6b1024e3f4\",\n \"message\": \"The applicant was not found.\",\n \"isUserFriendlyMessage\": true\n}"},{"id":"bdca1ea5-0c70-4a6e-b8f3-47a533cbf999","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","applicants",":applicantId","xrefkey"],"variable":[{"key":"applicantId","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"WWW-Authenticate","value":"Bearer error=\"invalid_token\", error_description=\"The token expired at '09/06/2023 16:25:02'\""},{"key":"Date","value":"Wed, 06 Sep 2023 16:42:11 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"16f5e010-50ea-4a68-b006-7a60a304edc4","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ApplicantApi/web-services/v1/applicants/1234/xrefkey"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"163"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Wed, 06 Sep 2023 16:45:47 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"1d9fb961-c551-424c-b24d-8f1448bafaa4\",\n \"message\": \"User does not have permission to perform this request.\",\n \"isUserFriendlyMessage\": true\n}"}],"_postman_id":"b90afe1c-91fb-4cc9-84a2-68fd092bcc7a"}],"id":"676b62db-eb19-4c0f-8486-ce7da87e39fd","description":"
The XrefKey is a unique ID (up to 64 characters) used to identify the applicant within the user's system. Our XrefKey endpoints are used to:
\n
\n
Allow users to assign a new XrefKey to an applicant so that the organization can relate them to the data in their system.
\n
\n
Allow users to delete an existing XrefKey associated with an applicant so that the organization can delete an existing Xrefkey and assign a new XrefKey to the applicant, using the PUT Assign Xref endpoint, if required.
\n
\n
\n
Assign or Delete an Xref to an Existing Applicant
\n
Required scopes: openid ApplicantApi
\n
Once an applicant is created, users can utilize the Xref endpoints to assign or delete a new XrefKey to that applicant as provided below:
\n
\n
If the applicant is created without an XrefKey, make a request to PUT {{Url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey to assign an XrefKey to an existing applicant. This returns a 200 OK response on success. Please note that an applicant can be associated with only one XrefKey and this request will return an error, if there is an existing XrefKey associated with the applicant.
\n
\n
Make a request to DEL {{Url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey to delete an existing XrefKey associated with an applicant. This returns a 200 OK response on success. This functionality allows the user to delete the existing XrefKey so that the user can assign a new XrefKey to the applicant using the PUT {{Url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey endpoint, if required.
There are some generic ApplicantAPI and RatingAPI endpoints that apply to all LOBs (EZAuto, EZHome, EZDwellingFire) to handle multiple functionalities.
This Tier 1 folder contains endpoints that has been described earlier in the documentation. However these are collected here to illustrate the Tier 1 capabilities and functionalities explicitly.
The 2 distinct functionalities of EZAuto endpoints are the following:
\n\n
Create, get or update an applicant along with Auto application data, using the Applicant API.
\n
\n
Create or update an applicant along with Auto application data AND simultaneously submit quote, using the Rating API.
\n
\n\n
Please note that an applicant can be created with or without XrefKey in both scenarios.
\n
The EZAuto workflow is as follows:
\n
Authenticate:
\n
\n
Get a token via our POST {{EzLynxIdentityUrl}}connect/token endpoint.
\n
\n
This should be set as an authorization header for the bearer (OAuth) token in the environment for the subsequent calls (Refer to the 'Authenticate' section for more information).
\n
\n
\n
Once authenticated, user can utilize our API endpoints to either create a new applicant with Auto application or submit quote and simultaneously create an applicant with Auto application as follows:
\n
Create a new applicant with Auto application:
\n
Required scopes: openid ApplicantApi
\n
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/applicants/auto to create a new applicant with Auto application. This returns an applicantId and applicant details URL. OR
\n
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/applicants/auto?xrefKey={{Xref_key}} to create a new applicant with an XrefKey and create Auto application. This returns an applicantId and applicant details URL.
\n
\n
\n
Get Auto Application Details
\n
Required scopes: openid ApplicantApi
\n
Once an applicant is created with an auto application, users can get that application data, using the GET endpoints as follows:
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/:applicantId/auto to get application details by applicantId. OR
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/auto?xrefKey={{Xref_key}} and pass the XrefKey to get application details by XrefKey.
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/:applicantId/auto/acord to get an Auto application by applicantId in ACORD format.
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/auto/acord?xrefKey={{Xref_key}} and pass the XrefKey to get application details by XrefKey in ACORD format.
\n
\n
\n
Notes: The EZAuto GET endpoints are used to get Auto application details associated with Applicants. This endpoint will not return other applications such as Home or DwellingFire even if the applicant has those applications. In order to get the Home or DwellingFire applications, you can use endpoints belonging to their respective LOBs.
\n
Update Applicant and Auto Application Details
\n
Required scopes: openid ApplicantApi
\n
Users can utilize the EZAuto PUT endpoints to update an existing applicant and create or update Auto application details.
\n
\n
Make a request to PUT {{Url}}/ApplicantApi/web-services/v1/applicants/{{applicant_Id}}/auto to update an existing applicant and Auto application details by applicantId. This returns the applicantId of the updated applicant and applicant details URL. OR
\n
\n
Make a request to PUT {{Url}}/ApplicantApi/web-services/v1/applicants/auto?xrefKey={{Xref_key}} to update an existing applicant and Auto application details by XrefKey. This returns the applicantId of the updated applicant and applicant details URL.
\n
\n
\n
Please note that when an applicant is created with Auto application details, users can replace it with the new application details using the EZAuto PUT endpoints. Also, if there are no existing auto application details, the EZAuto PUT endpoints can be used to create one.
\n
An applicant can be created with different LOBs like Auto, Home and Dwelling Fire application details. If an applicant is created with a specific LOB application detail, that applicant can be updated to add another LOB application details to it, if required.
\n
VIN Validation
\n
It’s a recommended practice to validate VIN before submitting a quote. Users can utilize the VIN Validation endpoints for the following:
\n
Send Full VIN
\n
Required scopes: openid ApplicantApi
\n
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/auto/metadata/vin endpoint to send in the full VIN to obtain vehicle data. This returns vehicle data for exact or closest matches.
\n
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/auto/metadata/vin-dest endpoint to send in a full VIN to obtain vehicle data with location. This returns vehicle data for exact or closest matches with a location indicator appended to each item for the provided VIN.
\n
\n
\n
If a full VIN is not available, a partial VIN can be used to obtain vehicle data. In order to obtain a partial VIN, send in the Year, Make, and Model of a vehicle in the GET Auto Submodels endpoint and the call response will provide a partial VIN which can be included in the EZAuto application.
\n
GET Vehicle Year/Make/Model
\n
Required scopes: openid ApplicantApi
\n
\n
Make a request to GET Auto Years endpoint (GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/years) to get the Year of a vehicle. This returns a list of years for vehicles (ranges from 1966-2024).
\n
\n
Make a request to GET Auto Make endpoint (GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/makes?year=2021)and send in a valid Year obtained from the previous step to get the Make of the vehicle. This returns a list of auto manufacturers.
\n
\n
Make a request to GET Auto Models’ endpoint (GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/models?year=2021&make=ford) and send in a valid Year and Make obtained from the previous steps to get the Model for the vehicle. This returns a list of auto models based on the Year and Make provided.
\n
\n
\n
GET Auto Sub-Models
\n
Required scopes: openid ApplicantApi
\n
\n
Make a request to GET Auto Submodels endpoint (GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models?year=2021&make=ford&model=BRONCO BASE) to get the auto submodel of a vehicle including a partial VIN. This returns a list of submodels with VIN, Body Style, Drive, Engine, Fuel and Transmission details.
\n
\n
Make a request to GET Auto Submodels All endpoint (GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/all?year=2021&make=ford&model=BRONCO BASE) to get an unfiltered list of submodels with partial VIN.
\n
\n
Make a request to GET Auto Submodels (Masked VIN) endpoint (GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/mask-vin?year=2021&make=ford&model=BRONCO BASE) to get the auto submodel of a vehicle with masked partial VIN. This returns the same result as GET Auto Submodels endpoint except that VINs will be masked.
\n
\n
Make a request to GET Auto Submodels (With Location) endpoint (GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/include-locations?year=2015&make=AUDI&model=A7 TECHNIK). This returns the same result as GET Auto Submodels endpoint except that a Location Indicator will be appended to each item and partial VINs will be masked.
\n
\n
\n
Apart from creating an applicant and Auto application using the Applicant API, the users can also create an applicant with Auto application data and submit quote simultaneously using the following Rating API endpoints as follows:
\n
Submit Quote and create a new applicant with Auto application
\n
Required scopes: openid RatingApi QAS
\n
Our APIs can be utilized to submit quote and create applicant with Auto application as follows:
\n
\n
Make a request to POST {{Url}}/RatingApi/web-services/v1/quotes/auto to submit quote and create an applicant and Auto application. This returns an applicantId and quoteExecutionId. OR
\n
\n
Make a request to POST {{Url}}/RatingApi/web-services/v1/quotes/auto?xrefKey={{Xref_key}} to submit quote and create an applicant with Xref and create Auto application. This returns an applicantId and quoteExecutionId
\n
\n
\n
Submit Auto Quote and update Applicant with Auto Application data
\n
Required scopes: openid RatingApi QAS
\n
Users can utilize the EZAuto PUT endpoints to submit Auto Quote and update Applicant with Auto Application data.
\n
\n
Make a request to PUT {{Url}}/RatingApi/web-services/v1/quotes/applicants/{{applicant_Id}}/auto to submit Auto Quote and update Applicant with Auto Application data by applicantId. This returns the applicantId and quoteExecutionId . OR
\n
\n
Make a request to PUT {{Url}}/RatingApi/web-services/v1/quotes/auto?xrefKey={{Xref_key}} to submit Auto Quote and update Applicant with Auto Application data by XrefKey. This returns the applicantId and quoteExecutionId
The 2 distinct functionalities of EZHome endpoints are the following:
\n\n
Create, get or update an applicant along with Home application data, using the Applicant API.
\n
\n
Create or update an applicant along with Home application data AND simultaneously submit quote, using the Rating API.
\n
\n\n
Please note that an applicant can be created with or without XrefKey in both scenarios.
\n
The EZHome workflow is as follows:
\n
Authenticate:
\n
\n
Get a token via our POST {{EzLynxIdentityUrl}}connect/token endpoint.
\n
\n
This should be set as an authorization header for the bearer (OAuth) token in the environment for the subsequent calls (Refer 'Authenticate' section for more information).
\n
\n
\n
Once authenticated, user can utilize our API endpoints to either create a new applicant with Home application or submit quote and create an applicant with Home Application as follows:
\n
Create a new applicant with Home Application:
\n
Required scopes: openid ApplicantApi
\n
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/applicants/home to create a new applicant and Home application data. This returns an applicantId and applicant details URL. OR
\n
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/applicants/home?xrefKey={{Xref_key}} to create a new applicant with an XrefKey and Home application data. This returns an applicantId and applicant details URL.
\n
\n
\n
Get Home application details:
\n
Required scopes: openid ApplicantApi
\n
Once an applicant is created with Home application, users can get that application details using the GET endpoints as follows:
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants//home and pass the applicantId to get application details by applicantId. OR
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/home?xrefKey={{Xref_key}} and pass the XrefKey to get application details by XrefKey.
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/20750670/home/acord to get application details by applicantId in ACORD format.
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/home/acord?xrefKey={{Xref_key}} to get application details by XrefKey in ACORD format.
\n
\n
\n
Notes: The EZHome GET endpoints are used to get Home application details associated with Applicants. This endpoint will not return other applications such as Auto or DwellingFire even if the applicant has those applications. In order to get the Auto or DwellingFire applications, you can use endpoints belonging to their respective LOBs.
\n
Update Applicant and Home Application Details
\n
Required scopes: openid ApplicantApi
\n
Users can utilize the EZHome PUT endpoints to update an existing applicant and create or update Home application details as follows:
\n
\n
Make a request to PUT {{Url}}/ApplicantApi/web-services/v1/applicants//home to update an existing applicant and Home application details by applicantId. This returns the applicantId of the updated applicant and applicant details URL. OR
\n
\n
Make a request to PUT {{Url}}/ApplicantApi/web-services/v1/applicants/home?xrefKey={{Xref_key}} to update an existing applicant and Home application details by XrefKey. This returns the applicantId of the updated applicant and applicant details URL.
\n
\n
\n
Please note that when an applicant is created with Home application details, users can replace it with the new application details using the EZHome PUT endpoints. Also, if there are no existing Home application details, the PUT endpoints can be used to create one.
\n
An applicant can be created with different LOBs like Auto, Home and Dwelling Fire application details. If an applicant is created with a specific LOB application detail, that applicant can be updated to add another LOB application details to it, if required.
\n
Apart from creating an applicant and Home application (as described above), the users can also create an applicant with Home application data and submit quote simultaneously using the following Rating API endpoints as follows:
\n
Submit Quote and create a new applicant with Home application
\n
Required scopes: openid RatingApi QAS
\n
Our APIs can be utilized to submit quote and create applicant with Home application as follows:
\n
\n
Make a request to POST {{Url}}/RatingApi/web-services/v1/quotes/home to submit quote and create an applicant and Home application. This returns an applicantId and quoteExecutionId. OR
\n
\n
Make a request to POST {{Url}}/RatingApi/web-services/v1/quotes/home?xrefKey={{Xref_key}} to submit quote and create an applicant with Xref and create Home application. This returns an applicantId and quoteExecutionId
\n
\n
\n
Submit Quote and update Applicant with Home Application data
\n
Required scopes: openid RatingApi QAS
\n
Users can utilize the EZHome PUT endpoints to submit Home Quote and update Applicant with Home Application data as follows:
\n
\n
Make a request to PUT {{Url}}/RatingApi/web-services/v1/quotes/applicants//home to submit Home Quote and update applicant with Home application data by applicantId. This returns the applicantId and quoteExecutionId
\n
\n
Make a request to PUT {{Url}}/RatingApi/web-services/v1/quotes/home?xrefKey={{Xref_key}} to submit Home Quote and update applicant with Home application data by XrefKey. This returns an applicantId and quoteExecutionId
The 2 distinct functionalities of EZDwellingFire endpoints are the following:
\n\n
Create, get or update an applicant along with Dwelling Fire application data, using the Applicant API.
\n
Create or update an applicant along with Dwelling Fire application data AND simultaneously submit quote, using the Rating API.
\n\n
Please note that an applicant can be created with or without XrefKey in both scenarios.
\n
The EZDwellingFire workflow is as follows:
\n
Authenticate:
\n
\n
Get a token via our POST {{EzLynxIdentityUrl}}connect/token endpoint.
\n
This should be set as an authorization header for the bearer (OAuth) token in the environment for the subsequent calls(Refer 'Authenticate' section for more information).
\n
\n
Once authenticated, user can utilize our API endpoints to either create a new applicant with Dwelling Fire application or submit quote and create an applicant with Dwelling Fire Application as follows:
\n
Create a new applicant with Dwelling Fire Application
\n
Required scopes: openid ApplicantApi
\n
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/applicants/dwelling-fire to create a new applicant and Dwelling Fire application data. This returns an applicantId and applicant details URL. OR
\n
Make a request to POST {{Url}}/ApplicantApi/web-services/v1/applicants/dwelling-fire?xrefKey={{Xref_key}} to create a new applicant with an XrefKey and Dwelling Fire application data. This returns an applicantId and applicant details URL.
\n
\n
Get Dwelling Fire Applicant Details
\n
Required scopes: openid ApplicantApi
\n
Once a new Dwelling Fire applicant is created, you can get the applicant details or update the applicant as follows:
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants//dwelling-fire to get application details by applicantId. OR
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/dwelling-fire?xrefKey={{Xref_key}} and pass the XrefKey to get application details by XrefKey.
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/20750670/dwelling-fire/acord to get application details by applicantId in ACORD format. OR
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants/dwelling-fire/acord?xrefKey=to get application details by XrefKey in ACORD format.
\n
\n
Notes: The EZDwellingFire GET endpoints are used to get DwellingFire application details associated with Applicants. This endpoint will not return other applications such as Auto or Home even if the applicant has those applications. In order to get the Auto or Home applications, you can use endpoints belonging to their respective LOBs.
\n
Update Applicant and Dwelling Fire Application Details
\n
Required scopes: openid ApplicantApi
\n
Users can utilize the EZDwellingFire PUT endpoints to update an existing applicant and create or update Dwelling Fire application details as follows:
\n
\n
Make a request to PUT {{Url}}/ApplicantApi/web-services/v1/applicants//dwelling-fire to update an existing applicant and Dwelling Fire application details by applicantId. This returns an applicantId and applicant details URL. OR
\n
Make a request to PUT {{Url}}/ApplicantApi/web-services/v1/applicants/dwelling-fire?xrefKey={{Xref_key}} to update an existing applicant and Dwelling Fire application details by XrefKey. This Returns an applicantId of the updated applicant and applicant details URL.
\n
\n
Please note that when an applicant is created with Dwelling Fire application details, users can replace it with the new application details using the EZDwellingFire PUT endpoints. Also, if there are no existing Dwelling Fire application details, the PUT endpoints can be used to create one.
\n
An applicant can be created with different LOBs like Auto, Home and Dwelling Fire application details. If an applicant is created with a specific LOB application detail, that applicant can be updated to add another LOB application details to it, if required.
\n
Apart from creating an applicant and Dwelling Fire application (as described above), the users can also create an applicant with Dwelling Fire application and submit quote simultaneously using the following Rating API endpoints as follows:
\n
Submit Quote and create a new applicant with Dwelling Fire application
\n
Required scopes: openid RatingApi QAS
\n
Our APIs can be utilized to submit quote and create applicant with Dwelling Fire application as follows:
\n
\n
Make a request to POST {{Url}}/RatingApi/web-services/v1/quotes/dwelling-fire to submit quote and create an applicant and Dwelling Fire application. This returns an applicantId and quoteExecutionId. OR
\n
Make a request to POST {{Url}}/RatingApi/web-services/v1/quotes/dwelling-fire?xrefKey={{Xref_key}} to submit quote and create an applicant with Xref and create Dwelling Fire application. This returns an applicantId and quoteExecutionId
\n
\n
Submit Quote and update Applicant with Dwelling Fire Application data
\n
Required scopes: openid RatingApi QAS
\n
Users can utilize the EZDwellingFire PUT endpoints to submit Dwelling Fire Quote and update Applicant with Dwelling Fire Application data as follows:
\n
\n
Make a request to PUT {{Url}}/RatingApi/web-services/v1/quotes/applicants//dwelling-fire to submit Dwelling Fire Quote and update applicant with Dwelling Fire application data by applicantId. This returns an applicantId and quoteExecutionId
\n
Make a request to PUT {{Url}}/RatingApi/web-services/v1/quotes/dwelling-fire?xrefKey={{Xref_key}} to submit Dwelling Fire Quote and update applicant with Dwelling Fire application data by XrefKey. This returns an applicantId and quoteExecutionId
\n
\n","_postman_id":"1c92609e-3869-4b9e-b26c-fc8e34b05d7a"},{"name":"Non-LOB Specific Endpoints","item":[{"name":"Xref Key","item":[{"name":"Assign Xref","event":[{"listen":"prerequest","script":{"id":"e92ac6a9-5b9f-450f-af0f-5cf92341e579","exec":["pm.collectionVariables.set(\"xref_key\", pm.variables.replaceIn(\"7dbd88dc-bf62-4d6e-af0d-07ab84dbe20a\"));"],"type":"text/javascript"}},{"listen":"test","script":{"id":"493795dc-2c6a-4699-8f36-f3686b32416d","exec":[""],"type":"text/javascript"}}],"id":"3657fa45-d12e-44cb-9702-579ddb021f63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey","description":"
Use: Assigns an XrefKey to an existing applicant, if that applicant is created without an XrefKey.
\n
Returns: Returns a 200 OK response on success. Please note that an applicant can be associated with only one Xrefkey. Hence, if the applicant is already created with an XrefKey, the user cannot assign a new Xref to that applicant and this request will return a 400 Bad Request Error message.
\n
NOTE: In order to change an existing XrefKey associated with an applicant, the user can utilize the Delete Xref endpoint to delete the existing Xrefkey first, and then use the PUT Assign Xref endpoint to assign a new XrefKey to that applicant.
\n
Responses and Descriptions:
\n
\n
Success:
\n
Returns a 200 OK status code on success.
\n
\n
\n
400 Bad Request- Duplicate xRefKey:
\n
The xRefKey sent in the request is already in use by an existing applicant.
\n","type":"text/plain"},"type":"any","value":"","key":"applicantId"}]}},"response":[{"id":"acf16123-2945-447e-89d4-1792028ca305","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","applicants",":applicantId","xrefkey"],"variable":[{"key":"applicantId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Mon, 31 Jul 2023 14:15:39 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"d0bb96a8-2d80-4149-ad6e-0b6cca22c278","name":"Not Found","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ApplicantApi/web-services/v1/applicants/1234875410/xrefkey"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"137"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Wed, 06 Sep 2023 16:44:36 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"cb936bdd-3776-425b-a9a0-37a69cab7311\",\n \"message\": \"The applicant was not found.\",\n \"isUserFriendlyMessage\": true\n}"},{"id":"39320ccd-bd35-43ff-aaeb-71d1e8f9f138","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","applicants",":applicantId","xrefkey"],"variable":[{"key":"applicantId","value":"","description":"The ID of the Applicant"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"WWW-Authenticate","value":"Bearer error=\"invalid_token\", error_description=\"The token expired at '09/06/2023 16:25:02'\""},{"key":"Date","value":"Wed, 06 Sep 2023 16:41:49 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"93eef612-8dad-44f5-9997-ac6b6576b594","name":"Forbidden","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ApplicantApi/web-services/v1/applicants/1234/xrefkey"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"163"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Wed, 06 Sep 2023 16:44:07 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"93b80df1-cc7a-4c08-9a9a-32c4a0067e4a\",\n \"message\": \"User does not have permission to perform this request.\",\n \"isUserFriendlyMessage\": true\n}"},{"id":"625813c4-aa49-4964-b09a-3a6ad0c497f9","name":"Bad Request - Duplicate xrefKey","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","applicants",":applicantId","xrefkey"],"variable":[{"key":"applicantId","value":"","description":"The ID of the Applicant"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"380"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Mon, 12 Feb 2024 15:18:39 GMT"}],"cookie":[],"responseTime":null,"body":"\n 90bbf02e-b67b-4340-be7d-53a6adb0883e\n The xrefKey is already in use or the applicant already has an xrefKey.\n BadRequest\n true\n"}],"_postman_id":"3657fa45-d12e-44cb-9702-579ddb021f63"},{"name":"Delete Xref","id":"7befadc0-bff1-41ce-b1e0-492a69dc47cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey","description":"
Use: Deletes an existing XrefKey associated with an applicant.
\n
Returns: Returns a 200 OK response on success.
\n
NOTE: Once an existing XrefKey is deleted, users can utilize the PUT Assign Xref endpoint to assign a new XrefKey to that applicant, if required.
\n
Responses and Descriptions:
\n
\n
Success:
\n
Returns a 200 OK status code on success.
\n
\n
\n
\n","urlObject":{"path":["ApplicantApi","web-services","v1","applicants",":applicantId","xrefkey"],"host":["{{url}}"],"query":[],"variable":[{"id":"ef3c1a0e-48e4-4113-af0a-4897cc02ab39","type":"any","value":"","key":"applicantId"}]}},"response":[{"id":"bfd4315f-d0fe-429c-bff1-e9418c46bc06","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","applicants",":applicantId","xrefkey"],"variable":[{"key":"applicantId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Mon, 31 Jul 2023 14:15:55 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"52632158-bf52-4163-9875-cbe9ee6a6c9d","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ApplicantApi/web-services/v1/applicants/1234086586/xrefkey"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"137"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Wed, 06 Sep 2023 16:46:11 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"6c515d37-e34d-4c1e-9987-6f6b1024e3f4\",\n \"message\": \"The applicant was not found.\",\n \"isUserFriendlyMessage\": true\n}"},{"id":"ade239e9-0746-4eff-b979-265a3a0fd3f5","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","applicants",":applicantId","xrefkey"],"variable":[{"key":"applicantId","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"WWW-Authenticate","value":"Bearer error=\"invalid_token\", error_description=\"The token expired at '09/06/2023 16:25:02'\""},{"key":"Date","value":"Wed, 06 Sep 2023 16:42:11 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"6077ee14-e0b6-4b5d-a5d6-86882ae0b142","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ApplicantApi/web-services/v1/applicants/1234/xrefkey"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"163"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Wed, 06 Sep 2023 16:45:47 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"1d9fb961-c551-424c-b24d-8f1448bafaa4\",\n \"message\": \"User does not have permission to perform this request.\",\n \"isUserFriendlyMessage\": true\n}"}],"_postman_id":"7befadc0-bff1-41ce-b1e0-492a69dc47cc"}],"id":"e412a329-67b3-4d58-8155-a4db75173cec","description":"
The XrefKey is a unique ID (up to 64 characters) used to identify the applicant within the user's system. Our XrefKey endpoints are used to:
\n
\n
Allow users to assign a new XrefKey to an applicant so that the organization can relate them to the data in their system.
\n
\n
Allow users to delete an existing XrefKey associated with an applicant so that the organization can delete an existing Xrefkey and assign a new XrefKey to the applicant, using the PUT Assign Xref endpoint, if required.
\n
\n
\n
Assign or Delete an Xref to an Existing Applicant
\n
Required scopes: openid ApplicantApi
\n
Once an applicant is created, users can utilize the Xref endpoints to assign or delete a new XrefKey to that applicant as provided below:
\n
\n
If the applicant is created without an XrefKey, make a request to PUT {{Url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey to assign an XrefKey to an existing applicant. This returns a 200 OK response on success. Please note that an applicant can be associated with only one XrefKey and this request will return an error, if there is an existing XrefKey associated with the applicant.
\n
\n
Make a request to DEL {{Url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey to delete an existing XrefKey associated with an applicant. This returns a 200 OK response on success. This functionality allows the user to delete the existing XrefKey so that the user can assign a new XrefKey to the applicant using the PUT {{Url}}/ApplicantApi/web-services/v1/applicants/:applicantId/xrefkey endpoint, if required.
\n
\n
\n","_postman_id":"e412a329-67b3-4d58-8155-a4db75173cec"},{"name":"Applicant Details","item":[{"name":"Get Applicant Details - By ApplicantId","id":"9ea97249-e7f4-43e4-b694-ba15231e07d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/ApplicantApi/web-services/v1/applicants/:applicantId","description":"
Use: Gets applicant details for a given applicantId
\n","type":"text/plain"},"key":"xrefKey","value":""}],"variable":[]}},"response":[{"id":"9d520fe9-b3fc-49b6-98ab-d21913147fa8","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/applicants?xrefKey=","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","applicants"],"query":[{"key":"xrefKey","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"1295"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Mon, 31 Jul 2023 14:16:37 GMT"}],"cookie":[],"responseTime":null,"body":"\n Hilma\n \n Harris\n Male\n MR\n Unknown\n Single\n Unknown\n Homemaker/House person / Homemaker/House person\n \n \n 20975891\n Unknown\n \n Current\n 123 test ave\n \n \n hous\n Austin\n TX\n 77573\n \n 3\n 0\n Unknown\n Unknown\n \n \n 7132314019\n \n \n \n \n PhoneMobile\n Unknown\n WebService\n 2023-07-31T09:16:30-05:00\n 2023-07-31T09:16:30.03-05:00\n"},{"id":"34458d36-f8b9-4ddc-af29-4019aeae80d1","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/applicants?xrefKey=","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","applicants"],"query":[{"key":"xrefKey","value":"","description":"Maximum 64 character unique string"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"WWW-Authenticate","value":"Bearer error=\"invalid_token\", error_description=\"The token expired at '09/06/2023 18:10:03'\""},{"key":"Date","value":"Wed, 06 Sep 2023 18:39:08 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"54cd4682-476e-4422-887e-ec45e72b16fa","name":"Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/applicants?xrefKey=1234","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","applicants"],"query":[{"key":"xrefKey","value":"1234","description":"Maximum 64 character unique string"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"135"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Wed, 06 Sep 2023 18:40:17 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"dee491a9-3f07-4751-8362-3794188e7005\",\n \"message\": \"The xrefKey was not found.\",\n \"isUserFriendlyMessage\": true\n}"},{"id":"99278dde-30bb-4d6a-bf68-317f792d17a6","name":"Bad Request - xrefKey > 65 characters","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/ApplicantApi/web-services/v1/applicants?xrefKey=89798798979874946563516321654987498796514321654162516549874965168","host":["{{url}}"],"path":["ApplicantApi","web-services","v1","applicants"],"query":[{"key":"xrefKey","value":"89798798979874946563516321654987498796514321654162516549874965168","description":"Maximum 64 character unique string"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Length","value":"446"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"Date","value":"Mon, 12 Feb 2024 15:20:20 GMT"}],"cookie":[],"responseTime":null,"body":"\n 00000000-0000-0000-0000-000000000000\n Model Validation Error\n \n One or more validation errors occurred.\n \n \n InternalServerError\n false\n"}],"_postman_id":"ad7f1dcd-2569-44e7-b0d8-757cc27ee898"}],"id":"79dc1c2f-f4a1-466d-91c3-86a256cdb715","description":"
The applicant details endpoints allow users to retrieve their agency’s accurate applicant details.
\n
Get Applicant Details:
\n
Required scopes: openid ApplicantApi
\n
Users can utilize the Applicant details endpoints to get the applicant details model for a given applicantId or XrefKey as follows:
\n
\n
Make a request to Get {{Url}}/ApplicantApi/web-services/v1/applicants/:applicantId to get applicant details by applicantId. This returns an Applicant details model.
\n
\n
Make a request to GET {{Url}}/ApplicantApi/web-services/v1/applicants?xrefKey={{Xref_key}} to get applicant details by XrefKey. This returns an applicant details model. However, if an applicant with a matching XrefKey does not exist, this will return a 404 Not Found error message.
The Quote Execution Details endpoint allows users to retrieve Quote Execution Details from carriers by QuoteExecutionID
\n
Get Quote Execution Details
\n
Required scopes: openid RatingApi
\n
\n
Pass the quoteExecutionId in the request GET {{Url}}/ratingapi/web-services/v1/quote-executions/:quoteExecutionId endpoint to get quote information from carriers. This returns premium details or errors for the quote executed (quoteExecutionId)
QuoteId received from ApplicantQuoteCompleted event
\n","type":"text/plain"},"type":"any","value":"","key":"applicantQuoteId"}]}},"response":[{"id":"680de527-03fe-4283-b25a-e644a0172935","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/RatingApi/web-services/v1/quotes/:applicantQuoteId?includeAlternateQuotes=true","host":["{{url}}"],"path":["RatingApi","web-services","v1","quotes",":applicantQuoteId"],"query":[{"key":"includeAlternateQuotes","value":"true","description":"Include alternate quotes in the result set. "}],"variable":[{"key":"applicantQuoteId","value":"","description":"QuoteId received from `ApplicantQuoteCompleted` event "}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Length","value":"5046"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408tUser44596tOrg21414"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Thu, 18 Sep 2025 20:40:00 GMT"}],"cookie":[],"responseTime":null,"body":"\n \n 2783074\n 20975899\n 2023-08-03T10:56:39.54\n WebServices Testing\n 7/31/2023 10:03:36 AM Applicant info uploaded via XML file.\n 2023-08-10T00:00:00\n TX\n 0\n \n 10822425\n Succeeded\n \n 2023-08-03T10:56:40.277\n 2023-08-03T10:56:48.737\n 100\n 12 Months Premium = $3071.00<br>(CCF# 0009436356125) <br><br>Please access the quote proposal and ACORD docs within the Travelers quote and issue system<br>\n \n \n \n \n \n Auto\n 12\n 3071.00\n Paid-In-Full\n 3071.00\n \n \n 0009436356125\n CCF#\n https://plagt4.dev.travelers.com/enteserv/isrjump.asp?CCF=0009436356125&SearchType=04&TargetPage=1&Report=com.webcetera&AppKey=10821260&LOB=AUTO&WIPSOURCE=STRATEGIC&CycleDate=2023-08-10\n \n Yes\n \n \n 500/500\n \n \n 100000\n \n \n 500/500\n \n \n 500/500\n \n \n None\n \n \n 10000\n \n \n No Coverage\n \n \n 25000\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n Please access the quote proposal and ACORD docs within the Travelers quote and issue system\n \n \n This risk qualifies for Quantum Auto 2.0.\n \n \n \n \n 3071.00\n \n \n Paid-In-Full\n \n \n \n \n 3375.00\n \n \n 562.61\n \n \n 255.67\n \n \n EFT\n \n \n \n \n 3443.00\n \n \n 573.95\n \n \n 260.82\n \n \n Monthly\n \n \n \n \n \n 500/500\n 1092.00\n \n \n 500/500\n 367.00\n \n \n 100000\n 367.00\n \n \n 500\n 551.00\n \n \n 500\n 454.00\n \n \n 100\n 9.00\n \n \n 25000\n 110.00\n \n \n 10000\n 116.00\n \n \n \n 116.00\n \n \n \n \n \n \n \n"},{"id":"36524ad7-e925-49e0-99d5-a6a47daf451f","name":"Not Found","originalRequest":{"method":"GET","header":[],"url":"{{url}}/RatingApi/web-services/v1/quotes/1234985671"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"137"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Wed, 06 Sep 2023 16:47:57 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"f33e7bb5-f987-453e-8125-2f989d2711ca\",\n \"message\": \"The applicant was not found.\",\n \"isUserFriendlyMessage\": true\n}"},{"id":"9ef2e440-5ca8-498d-be4a-0ee660bd2e01","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/RatingApi/web-services/v1/quotes/:applicantQuoteId","host":["{{url}}"],"path":["RatingApi","web-services","v1","quotes",":applicantQuoteId"],"variable":[{"key":"applicantQuoteId","value":"","description":"QuoteId received from `ApplicantQuoteCompleted` event "}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"WWW-Authenticate","value":"Bearer error=\"invalid_token\", error_description=\"The token expired at '09/06/2023 16:25:02'\""},{"key":"Date","value":"Wed, 06 Sep 2023 16:33:19 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"dbdfa876-b591-4c03-8f46-4bc613ded575","name":"Forbidden","originalRequest":{"method":"GET","header":[],"url":"{{url}}/RatingApi/web-services/v1/quotes/1234"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"163"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"x-ezlynx-user","value":"v-org21408"},{"key":"api-supported-versions","value":"1"},{"key":"Date","value":"Wed, 06 Sep 2023 16:47:34 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"traceId\": \"f40775a3-7ebe-4aec-9e33-83e2a74a040e\",\n \"message\": \"User does not have permission to perform this request.\",\n \"isUserFriendlyMessage\": true\n}"}],"_postman_id":"46bcd4d7-eb63-4719-a765-a1103d5d3db8"}],"id":"a6dced79-186e-4e49-ad1b-f61bca378673","description":"
The Applicant Quote endpoint is used to retrieve an applicant's Quote Details.
\n
Get Applicant Quote Details
\n
Required scopes: openid RatingApi
\n
Once quotes are completed, an ApplicantQuoteCompleted event will be invoked internally in EZLynx which will contain the applicantQuoteID. EZLynx then calls the user’s webhook (API) with the applicantQuoteId.
\n
\n
Pass the applicantQuoteId in the request GET {{Url}}/RatingApi/web-services/v1/quotes/:applicantQuoteId?includeAlternateQuotes=true to get applicant quote details model. This returns applicantQuoteDetailsType data.
There are some generic ApplicantAPI and RatingAPI endpoints that apply to all LOBs (EZAuto, EZHome, EZDwellingFire) to handle multiple functionalities.
This Tier 1.5 folder contains endpoints that has been described earlier in the documentation. However these are collected here to illustrate the Tier 1 capabilities and functionalities explicitly.
\n","_postman_id":"ef3d24c6-71a0-457c-9e00-0586efa1e473"}],"event":[{"listen":"prerequest","script":{"id":"39f76ea1-bda8-4e6d-9751-81ab6cdad859","type":"text/javascript","exec":["var severDaysLater = new Date();","severDaysLater.setDate(severDaysLater.getDate() + 7);","pm.collectionVariables.set(\"seven_days_later\", severDaysLater.toISOString().substring(0,10));","var today = new Date();","pm.collectionVariables.set(\"today\", today.toISOString().substring(0,10));","pm.collectionVariables.set(\"quote_id\", 2783074);",""]}},{"listen":"test","script":{"id":"846c9525-4c9c-49cb-b872-5de8128489a5","type":"text/javascript","exec":[""]}}],"variable":[{"key":"token","value":""},{"key":"deleteApplicantId","value":"0"},{"key":"SystemClientSecret","value":"secret"},{"key":"system_access_token","value":""},{"key":"applicant_id","value":""},{"key":"xref_key","value":""},{"key":"seven_days_later","value":""},{"key":"first_name","value":""},{"key":"last_name","value":""},{"key":"quote_id","value":""},{"key":"quote_execution_id","value":""},{"key":"today","value":""},{"key":"auto_applicant_id","value":""},{"key":"auto_xref_key","value":""},{"key":"home_applicant_id","value":""},{"key":"home_xref_key","value":""},{"key":"dwelling_applicant_id","value":""},{"key":"dwelling_xref_key","value":""},{"key":"masterCompanyId","value":""}]}