### Get Auto Application Details by XrefKey Source: https://documenter.getpostman.com/view/7956984/2s9YBxac8Q/index Retrieve details for an existing Auto application using the XrefKey. This endpoint provides application data associated with the provided key. ```HTTP GET {{Url}}/ApplicantApi/web-services/v1/applicants/auto?xrefKey={{Xref_key}} ``` -------------------------------- ### Get Auto Application Details in ACORD Format by XrefKey Source: https://documenter.getpostman.com/view/7956984/2s9YBxac8Q/index Retrieve Auto application details by XrefKey in ACORD format. This facilitates data retrieval in a standardized structure. ```HTTP GET {{Url}}/ApplicantApi/web-services/v1/applicants/auto/acord?xrefKey={{Xref_key}} ``` -------------------------------- ### GET Vehicle Model Metadata Source: https://documenter.getpostman.com/view/7956984/2s9YBxac8Q/index Retrieves a list of vehicle models for a given year and make. Requires valid year and make parameters obtained from previous steps. ```REST GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/models?year=2021&make=ford ``` -------------------------------- ### Get Auto Application Details in ACORD Format by ApplicantId Source: https://documenter.getpostman.com/view/7956984/2s9YBxac8Q/index Retrieve Auto application details by applicantId in ACORD format. This is useful for standardized data exchange. ```HTTP GET {{Url}}/ApplicantApi/web-services/v1/applicants/:applicantId/auto/acord ``` -------------------------------- ### Get Auto Application Details by ApplicantId Source: https://documenter.getpostman.com/view/7956984/2s9YBxac8Q/index Retrieve details for an existing Auto application using the applicantId. This endpoint returns application data in a standard format. ```HTTP GET {{Url}}/ApplicantApi/web-services/v1/applicants/:applicantId/auto ``` -------------------------------- ### GET Vehicle Make Metadata Source: https://documenter.getpostman.com/view/7956984/2s9YBxac8Q/index Retrieves a list of auto manufacturers (makes) for a specified year. Requires a valid year obtained from the 'GET Vehicle Year Metadata' endpoint. ```REST GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/makes?year=2021 ``` -------------------------------- ### Authenticate: Get Token Source: https://documenter.getpostman.com/view/7956984/2s9YBxac8Q/index Obtain an OAuth bearer token by making a POST request to the token endpoint. This token is required for subsequent authenticated API calls. ```HTTP POST {{EzLynxIdentityUrl}}connect/token ``` -------------------------------- ### GET Vehicle Sub-Model Metadata Source: https://documenter.getpostman.com/view/7956984/2s9YBxac8Q/index Retrieves detailed sub-model information for a vehicle, including partial VIN, body style, engine, and transmission. Requires year, make, and model parameters. ```REST GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models?year=2021&make=ford&model=BRONCO BASE ``` -------------------------------- ### GET All Vehicle Sub-Models (Unfiltered) Source: https://documenter.getpostman.com/view/7956984/2s9YBxac8Q/index Retrieves an unfiltered list of all vehicle sub-models, including partial VIN details. This endpoint provides a comprehensive list without specific filtering. ```REST GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/all?year=2021&make=ford&model=BRONCO BASE ``` -------------------------------- ### Authenticate and Get Access Token (cURL) Source: https://documenter.getpostman.com/view/7956984/2s9YBxac8Q/index This cURL command demonstrates how to authenticate with the Connect Web Services API to obtain an access token. It requires client credentials, grant type, scope, username, and integration group ID. The obtained token is used for subsequent requests. ```cURL curl --location -g '{{url}}/auth/connect/token' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'client_id={{ClientId}}' \ --data-urlencode 'client_secret={{ClientSecret}}' \ --data-urlencode 'grant_type=vendor_data_access' \ --data-urlencode 'scope=ApplicantApi RatingApi openid QAS' \ --data-urlencode 'username={{username}}' \ --data-urlencode 'integration_group_id={{integration_group_id}}' ``` -------------------------------- ### GET Vehicle Year Metadata Source: https://documenter.getpostman.com/view/7956984/2s9YBxac8Q/index Retrieves a list of valid vehicle years (e.g., 1966-2024) from the Auto Years endpoint. This is the first step in fetching detailed vehicle information. ```REST GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/years ``` -------------------------------- ### GET Vehicle Sub-Model Metadata (With Location) Source: https://documenter.getpostman.com/view/7956984/2s9YBxac8Q/index Retrieves vehicle sub-model information with an appended Location Indicator and masked partial VINs. This endpoint provides location context for each sub-model. ```REST GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/include-locations?year=2015&make=AUDI&model=A7 TECHNIK ``` -------------------------------- ### GET Vehicle Sub-Model Metadata (Masked VIN) Source: https://documenter.getpostman.com/view/7956984/2s9YBxac8Q/index Retrieves vehicle sub-model information with masked partial VINs. This is useful for privacy-sensitive applications while still providing essential details. ```REST GET {{Url}}/ApplicantApi/web-services/v1/auto/metadata/sub-models/mask-vin?year=2021&make=ford&model=BRONCO BASE ``` -------------------------------- ### Create Applicant: Auto Application Source: https://documenter.getpostman.com/view/7956984/2s9YBxac8Q/index Create a new applicant with an Auto application. This can be done with or without an XrefKey. The response includes the applicantId and a URL for applicant details. ```HTTP POST {{Url}}/ApplicantApi/web-services/v1/applicants/auto ``` ```HTTP POST {{Url}}/ApplicantApi/web-services/v1/applicants/auto?xrefKey={{Xref_key}} ``` -------------------------------- ### POST Submit Auto Quote and Create Applicant Source: https://documenter.getpostman.com/view/7956984/2s9YBxac8Q/index Submits an auto quote and simultaneously creates a new applicant with associated Auto application data. Returns applicantId and quoteExecutionId. ```REST POST {{Url}}/RatingApi/web-services/v1/quotes/auto ``` ```REST POST {{Url}}/RatingApi/web-services/v1/quotes/auto?xrefKey={{Xref_key}} ``` -------------------------------- ### Update Applicant and Auto Application by XrefKey Source: https://documenter.getpostman.com/view/7956984/2s9YBxac8Q/index Update an existing applicant and their Auto application details using the XrefKey. This endpoint can also be used to create an Auto application if it does not exist. ```HTTP PUT {{Url}}/ApplicantApi/web-services/v1/applicants/auto?xrefKey={{Xref_key}} ``` -------------------------------- ### PUT Submit Auto Quote and Update Applicant Source: https://documenter.getpostman.com/view/7956984/2s9YBxac8Q/index Submits an auto quote and updates an existing applicant with Auto Application data. Can be performed using either applicantId or XrefKey. ```REST PUT {{Url}}/RatingApi/web-services/v1/quotes/applicants/{{applicant_Id}}/auto ``` ```REST PUT {{Url}}/RatingApi/web-services/v1/quotes/auto?xrefKey={{Xref_key}} ``` -------------------------------- ### VIN Validation: Send Full VIN Source: https://documenter.getpostman.com/view/7956984/2s9YBxac8Q/index Submit a full Vehicle Identification Number (VIN) to obtain vehicle data. This returns data for exact or closest matches. ```HTTP POST {{Url}}/ApplicantApi/web-services/v1/auto/metadata/vin ``` -------------------------------- ### VIN Validation: Send Full VIN with Location Source: https://documenter.getpostman.com/view/7956984/2s9YBxac8Q/index Submit a full VIN to retrieve vehicle data along with a location indicator for each match. This provides more granular location-specific information. ```HTTP POST {{Url}}/ApplicantApi/web-services/v1/auto/metadata/vin-dest ``` -------------------------------- ### Update Applicant and Auto Application by ApplicantId Source: https://documenter.getpostman.com/view/7956984/2s9YBxac8Q/index Update an existing applicant and their Auto application details using the applicantId. This operation can also create an Auto application if none exists. ```HTTP PUT {{Url}}/ApplicantApi/web-services/v1/applicants/{{applicant_Id}}/auto ``` -------------------------------- ### Authentication Response (JSON) Source: https://documenter.getpostman.com/view/7956984/2s9YBxac8Q/index This JSON object represents a successful authentication response from the Connect Web Services API. It contains the access token, token type, expiration time, and granted scopes, which are essential for making authenticated API calls. ```json { "access_token": "token", "expires_in": 3600, "token_type": "Bearer", "scope": "ApplicantApi openid QAS RatingApi" } ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.