Description
By using this API, relativities by coverage for Physical Damage and/or Liability will be returned depending on the user subscription. Multiple vehicles may be returned in an array for some VIN inputs. See the special handling section in the ISO Risk Analyzer® Personal Auto Vehicle Symbols Software Information Kit (SIK) for further information on these cases. The most common cause of multiple records being returned is that two (or more) engine types or four wheel drive indicators can be associated with a given VIN.
The optional EffectiveDate parameter will return vehicle records from a specified historical date. Symbols may change over time in subsequent releases as vehicle experience emerges. The absence of the optional EffectiveDate parameter will return the latest symbols as of today, but including the EffectiveDate in YYYYMMDD format will return what the symbols were on that historical date.
Three optional parameters include Exclusion=Y, StateCode =CA and StateCode=GA. When Exclusion=Y is used the components will not be shown in the API output. When StateCode=CA is used the California-specific values will replace the non-California fields where appropriate. When StateCode=GA is used the Georgia-specific values will replace the non-Georgia fields where appropriate. See the SIK for information on the Georgia-specific and California-specific fields.
Technical Details
- REST URL’s
- User Acceptance Environment (UAT)
- https://gatewayuat.verisk.com/rating/riskanalyzerpersonalauto/vin/search/v3
- Production (PROD)
- https://gateway.verisk.com/rating/riskanalyzerpersonalauto/vin/search/v3
- HTTP Method
- Headers (JSON)
- Content-Type: application/json
- Accept: application/json
- Authorization: Bearer <access token retrieved from Security Token Service>
- Token received from Security Service should be used as Bearer
- Form Data
- Required Parameters
- OrgId: Request.Header.Authorization.OrgId
- ShipId: Request.Header.Authorization.ShipId
- At least one parameter is required out of six:
- VIN: Request.Body.VIN
- ModelYear: Request.Body.ModelYear
- Make: Request.Body.Make
- FullModelName: Request.Body.FullModelName
- BodyStyle: Request.Body.BodyStyle style
- BasicModelName: Request.Body.BasicModelName
- Optional Parameters
- Quoteback: Request.Header.Quoteback
- FourWheelDriveIndicator: Request.Body.FourWheelDriveIndicator
- EngineCylinders: Request.Body.EngineCylinders
- StateCode: Request.Body.StateCode
- Exclusion: Request.Body.Exclusion
- DistributionDate: Request.Body.DistributionDate
- EffectiveDate: Request.Body.EffectiveDate
- EngineType: Request.Body.EngineType
- EngineSize: Request.Body.EngineSize
If a searched VIN is not in the database, the API will run an additional lookup based on the same Make/Trim and a prior Model year. The API will return Symbols and associated rating relativities if there is a match. To determine if a successful API response has utilized the prior model year lookup to return a match, check that the Interim Indicator field is “Y”. If this secondary lookup process was not needed then the Interim Indicator field will be blank.
- Headers
- Regardless of which URL you are using, the following headers are required
- Content-Type: application/json
- Accept: application/json
- Authorization: Bearer db6e8bdf3b8ce796d38f2cd4298d252
Samples and Schemas¶
- Please contact VehAPIHELP@verisk.com or your Account Executive for Request/Response Samples and Schemas.
Release Notes
- RAPA Symbols V1 to V2
- REST URL updated from /v2 to /v3
- Description updated
- Form Data updated Required Parameters to include BasicModelName: Request.Body.BasicModelName
- Form Data updated Optional Parameters to include DistributionDate: Request.Body.DistributionDate
- Form Data updated Optional Parameters to remove PhysicalDamageDistributionDate: Request.Body.PhysicalDamageDistributionDate and LiabilityDistributionDate: Request.Body.LiabilityDistributionDate