POST VIN/ConfirmVinPlus

Request Information

URI Parameters

None.

Body Parameters

ConfirmVINPlusDTO
NameDescriptionTypeAdditional information
useVinPlus

boolean

None.

vinPlusResult

VINPlusResultDTO

None.

vinClassicResult

VINClassicResultDTO

None.

assessmentId

globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "useVinPlus": true,
  "vinPlusResult": {
    "ResultCode": "OK",
    "Message": "sample string 1",
    "VIN": "sample string 2",
    "Manufacturer": "sample string 3",
    "Model": "sample string 4",
    "Submodel": "sample string 5",
    "ModelOptions": "sample string 6",
    "Version": "sample string 7",
    "OriginalCode": "sample string 8",
    "ResultMessage": "sample string 9",
    "UnsupportedOptions": "sample string 10",
    "QueryId": "sample string 11",
    "PaintCode": "sample string 12",
    "VehicleType": "Uninitialised"
  },
  "vinClassicResult": {
    "ReturnCode": "Ok",
    "ReturnMessage": "sample string 1",
    "VINData": [
      {
        "VINNumber": "sample string 1",
        "ManufacturerCode": "sample string 2",
        "ModelCode": "sample string 3",
        "SubModelCode": "sample string 4",
        "DoorCode": "sample string 5",
        "EngineCode": "sample string 6",
        "DateCode": "sample string 7",
        "Make": "sample string 8",
        "Model": "sample string 9",
        "Colour": "sample string 10",
        "BodyStyle": "sample string 11",
        "EngineSize": "sample string 12",
        "FuelType": "sample string 13",
        "Transmission": "sample string 14",
        "DateFirstRegistered": "sample string 15",
        "VehicleType": "Uninitialised",
        "Registration": "sample string 16"
      },
      {
        "VINNumber": "sample string 1",
        "ManufacturerCode": "sample string 2",
        "ModelCode": "sample string 3",
        "SubModelCode": "sample string 4",
        "DoorCode": "sample string 5",
        "EngineCode": "sample string 6",
        "DateCode": "sample string 7",
        "Make": "sample string 8",
        "Model": "sample string 9",
        "Colour": "sample string 10",
        "BodyStyle": "sample string 11",
        "EngineSize": "sample string 12",
        "FuelType": "sample string 13",
        "Transmission": "sample string 14",
        "DateFirstRegistered": "sample string 15",
        "VehicleType": "Uninitialised",
        "Registration": "sample string 16"
      }
    ]
  },
  "assessmentId": "7befb72f-ac21-4b02-9344-af663d090c8d"
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

WebApiResultOfAssessmentWrapperOfAssessment
NameDescriptionTypeAdditional information
Success

boolean

None.

Data

AssessmentWrapperOfAssessment

None.

ErrorMessage

string

None.

Exception

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Data": {
    "Assessment": {
      "SnapshotId": "285b25b8-9f85-4897-a36e-7f6016a88b49",
      "Obid": "2eb616fb-e802-4d62-9bc4-d477fbd5d2fe",
      "UserId": "ae9b567d-01bc-4cbd-94f1-3a07092da61a",
      "CompanyId": "67fb2a1d-dd4e-4e41-a610-6868dcbdb1e6",
      "Created": "2025-05-15T16:02:20.8113895+01:00",
      "AssessmentNumber": "sample string 6",
      "ReferenceName": "sample string 7",
      "Originator": "sample string 8",
      "State": "sample string 9",
      "AuthorisationStatus": "Uninitialised",
      "LastUpdated": "2025-05-15T16:02:20.8113895+01:00",
      "AssessmentNotes": [
        {
          "Obid": "906c7cd3-6bce-4234-b01f-d4dc9298b1c0",
          "Author": "sample string 1",
          "DateCreated": "2025-05-15T16:02:20.8113895+01:00",
          "Header": "sample string 2",
          "Text": "sample string 3"
        },
        {
          "Obid": "906c7cd3-6bce-4234-b01f-d4dc9298b1c0",
          "Author": "sample string 1",
          "DateCreated": "2025-05-15T16:02:20.8113895+01:00",
          "Header": "sample string 2",
          "Text": "sample string 3"
        }
      ],
      "Vehicle": {
        "Vin": "sample string 1",
        "Registration": "sample string 2",
        "MonthOfRegistration": 1,
        "YearOfRegistration": 1,
        "BodyColour": "sample string 3",
        "TyreCondition": "sample string 4",
        "SteeringCondition": "sample string 5",
        "BrakesCondition": "sample string 6",
        "PreAccidentCondition": "sample string 7",
        "ConditionDetails": "sample string 8",
        "DamageCondition1": "CompletedAndReturned",
        "DamageCondition2": "CompletedAndReturned",
        "DamageSeverity": "Uninitialised",
        "DamageSeverity2": "Uninitialised",
        "Odometer": 1,
        "OdometerTBA": true,
        "SpareTyreDepth1": 1.1,
        "SpareTyreDepth2": 1.1,
        "TyreDepths": [
          {
            "Axle": 1,
            "LeftTyre": 1.1,
            "RightTyre": 1.1
          },
          {
            "Axle": 1,
            "LeftTyre": 1.1,
            "RightTyre": 1.1
          }
        ],
        "DamageAreas": [
          0,
          0
        ],
        "ImpactDirections": [
          {
            "ImpactStartArea": 0,
            "ImpactEndArea": 0
          },
          {
            "ImpactStartArea": 0,
            "ImpactEndArea": 0
          }
        ],
        "UnderWarranty": "Uninitialised",
        "WarrantyExpire": "2025-05-15T16:02:20.8113895+01:00",
        "SelectionMethod": "Manual"
      },
      "Model": {
        "ModelType": "Full",
        "VehicleType": "Uninitialised",
        "ManufacturerName": "sample string 1",
        "ModelName": "sample string 2",
        "ManufactureCode": "sample string 3",
        "ModelCode": "sample string 4",
        "SubModelCode": "sample string 5",
        "EngineCode": "sample string 6",
        "DoorsCode": "sample string 7",
        "PaintCodes": "sample string 8",
        "PaintMethod": "sample string 9",
        "DateCode": "sample string 10",
        "ModelOptions": [
          "sample string 1",
          "sample string 2"
        ]
      },
      "Calculation": {
        "CalculationDate": "2025-05-15T16:02:20.8113895+01:00",
        "GrandTotalIncludingVat": 1.0,
        "GrandTotalExcludingVat": 1.0,
        "Parts": [
          {
            "Amount": 1.0,
            "ReferenceSequence": 1,
            "Description": "sample string 1",
            "PartNumber": "sample string 2",
            "GuideNumber": 1,
            "RepairMethod": "Uninitialised"
          },
          {
            "Amount": 1.0,
            "ReferenceSequence": 1,
            "Description": "sample string 1",
            "PartNumber": "sample string 2",
            "GuideNumber": 1,
            "RepairMethod": "Uninitialised"
          }
        ],
        "InvalidParts": [
          {
            "ErrorCode": "sample string 1",
            "Description": "sample string 2",
            "PartNumber": "sample string 3",
            "GuideNumber": 1,
            "RepairMethod": "Uninitialised"
          },
          {
            "ErrorCode": "sample string 1",
            "Description": "sample string 2",
            "PartNumber": "sample string 3",
            "GuideNumber": 1,
            "RepairMethod": "Uninitialised"
          }
        ],
        "TotalLabourInVat": 1.0,
        "TotalPartsInVat": 1.0,
        "TotalPaintInVat": 1.0,
        "TotalOthersInVat": 1.0,
        "ManualAdjustment": 1.0,
        "VatRate": 2.0,
        "VatAmount": 3.0,
        "NonPaintTimeBasis": 1,
        "PaintTimeBasis": 1,
        "PartPriceDate": "2025-05-15T16:02:20.8113895+01:00",
        "VisualAlignmentWu": 1.0,
        "LabourClass1Wu": 1.0,
        "LabourClass5Wu": 1.0,
        "EstimateTotal": 4.0,
        "GeneralCosts": {
          "DeductionAdditionalAmt": 1.0,
          "LabourAmt5": 1.0,
          "LabourPanelMechAmt": 1.0,
          "LbrAmtDecrease": 1.0,
          "LbrAmtIncrease": 1.0,
          "PartsAmt": 1.0,
          "PartsSaving": 1.0,
          "SundryPartsAmt": 1.0,
          "SundryPartsPcnt": 1.0,
          "TotalLabourAmt": 1.0,
          "TotalPartsAmt": 1.0,
          "VisualAlignmentAmt": 1.0,
          "TotalAdditionalCosts": 1.0
        },
        "PaintCosts": {
          "FixedPaintMaterialAmt": 1.0,
          "FlatMaterialAmt": 1.0,
          "IndexChangeAmt": 1.0,
          "LabourPaintAmt": 1.0,
          "MatConPrePnt": 1.0,
          "MatConstMetalAmt": 1.0,
          "MatConstPerSpotAmt": 1.0,
          "MatConstPlasticAmt": 1.0,
          "MatConstSpotAmt": 1.0,
          "NewPartAmt": 1.0,
          "NewPartMetalAmt": 1.0,
          "NewPartPlasticLE1Amt": 1.0,
          "NewPartPlasticLE2Amt": 1.0,
          "NewPartPlasticLE3Amt": 1.0,
          "NewPartPlasticLE4Amt": 1.0,
          "PaintDiscountAmount": 1.0,
          "PaintMaterialAmt": 1.0,
          "PearlescentPaintAmt": 1.0,
          "PrepWorkPlasticWU": 1.0,
          "PrepWorkMetalWU": 1.0,
          "PrepWorkMultilayerWU": 1.0,
          "PrepInCaseofPrepaint": 1.0,
          "RepairAmt": 1.0,
          "RepairPaintMetalAmt": 1.0,
          "RepairPaintPlasticAmt": 1.0,
          "SpotPaintMatAmt": 1.0,
          "SurfaceAmt": 1.0,
          "SurfacePaintMetalAmt": 1.0,
          "SurfacePaintPlasticAmt": 1.0,
          "TotalPaintWU": 1.0,
          "SundryCostsAmt": 1.0,
          "PreparePaintSundryAmt": 1.0,
          "PrepSinglePanelOffCar": 1.0,
          "PreparePartsWU": 1.0,
          "PrepPanelsOffCar": 1.0
        },
        "HasFrozenParts": true
      },
      "Rate": {
        "LabourRate": 1.0,
        "LabourRate5": 1.0,
        "LabourClass1Wu": 1.0,
        "LabourClass5Wu": 1.0,
        "PaintRate": 1.0,
        "PaintIndex": 1.1,
        "PartsDiscount": 1.1,
        "OverallDiscount": 1.1,
        "PartsDiscountPcnt": 1.1,
        "PearlescentUpliftPcnt": 1.1,
        "PearlescentEditable": true
      },
      "Repairs": [
        {
          "OperationType": "Standard",
          "GuideNumber": 1,
          "RepairMethod": "sample string 2",
          "WorkUnits": 1,
          "Price": 1.0,
          "Comment": "sample string 3",
          "Description": "sample string 4",
          "WorkText": "sample string 5",
          "BettermentPercent": 1.1,
          "Mutations": [
            {
              "Code": "sample string 1",
              "Value": "sample string 2"
            },
            {
              "Code": "sample string 1",
              "Value": "sample string 2"
            }
          ]
        },
        {
          "OperationType": "Standard",
          "GuideNumber": 1,
          "RepairMethod": "sample string 2",
          "WorkUnits": 1,
          "Price": 1.0,
          "Comment": "sample string 3",
          "Description": "sample string 4",
          "WorkText": "sample string 5",
          "BettermentPercent": 1.1,
          "Mutations": [
            {
              "Code": "sample string 1",
              "Value": "sample string 2"
            },
            {
              "Code": "sample string 1",
              "Value": "sample string 2"
            }
          ]
        }
      ],
      "ImageMetadata": [
        {
          "Obid": "19430247-1b11-42f2-8d3a-224dd86c86da",
          "CreatedDate": "2025-05-15T16:02:20.8113895+01:00",
          "DisplayOrder": 1,
          "SequenceNumber": 1
        },
        {
          "Obid": "19430247-1b11-42f2-8d3a-224dd86c86da",
          "CreatedDate": "2025-05-15T16:02:20.8113895+01:00",
          "DisplayOrder": 1,
          "SequenceNumber": 1
        }
      ],
      "LocalNotes": [
        {
          "Obid": "056ac2e5-416a-4c2c-9f6b-a77c322d9639",
          "Author": "sample string 1",
          "DateCreated": "2025-05-15T16:02:20.8113895+01:00",
          "Header": "sample string 2",
          "Text": "sample string 3"
        },
        {
          "Obid": "056ac2e5-416a-4c2c-9f6b-a77c322d9639",
          "Author": "sample string 1",
          "DateCreated": "2025-05-15T16:02:20.8113895+01:00",
          "Header": "sample string 2",
          "Text": "sample string 3"
        }
      ],
      "RepairsAuthorised": true,
      "Claim": {
        "DateOfDecision": "2025-05-15T16:02:20.8113895+01:00",
        "DateOfAccident": "2025-05-15T16:02:20.8113895+01:00",
        "DateOfAccidentUnknown": true,
        "DateOfInspection": "2025-05-15T16:02:20.8113895+01:00",
        "DateBookedForRepair": "2025-05-15T16:02:20.8113895+01:00",
        "VehicleAtInspectionSite": true,
        "EngineerInspectionRequested": true,
        "ClaimNumber": "sample string 8",
        "OtherReference": "sample string 9",
        "PartnerNumber": "sample string 10",
        "HandlingFee": 11.0,
        "InsuredAmount": 12.0,
        "RepairValue": 13.0,
        "RepairValueTBA": true
      },
      "AbleToAuthorise": true,
      "Policy": {
        "PolicyNumber": "sample string 1",
        "ExcessValue": 2.0,
        "ExcessValueTBA": true,
        "VATStatus": "Uninitialised",
        "VATPortionPayable": 4.0
      },
      "lockedBy": {
        "userName": "sample string 1",
        "LockedOn": "2025-05-15T16:02:20.8113895+01:00"
      },
      "CountryState": {
        "ISOCODE": "sample string 1",
        "CurrencyDefinition": {
          "Code": "sample string 1"
        }
      },
      "Contacts": [
        {
          "ContactType": "Uninitialised",
          "Name": "sample string 1",
          "Title": "sample string 2",
          "Forename": "sample string 3",
          "Surname": "sample string 4",
          "EMailAddress": "sample string 5",
          "Line01": "sample string 6",
          "Line02": "sample string 7",
          "Line03": "sample string 8",
          "Line04": "sample string 9",
          "Line05": "sample string 10",
          "PostCode": "sample string 11"
        },
        {
          "ContactType": "Uninitialised",
          "Name": "sample string 1",
          "Title": "sample string 2",
          "Forename": "sample string 3",
          "Surname": "sample string 4",
          "EMailAddress": "sample string 5",
          "Line01": "sample string 6",
          "Line02": "sample string 7",
          "Line03": "sample string 8",
          "Line04": "sample string 9",
          "Line05": "sample string 10",
          "PostCode": "sample string 11"
        }
      ],
      "CurrencyDefinition": {
        "Code": "sample string 1"
      },
      "WorkProvider": {
        "ID": "3920bddb-9306-4d2c-8d2e-fe5b9bd54513",
        "Description": "sample string 2",
        "Code": 3,
        "Option": {
          "AllowCreateAssessment": true,
          "AttachmentMaxCount": 2,
          "AttachmentMaxSize": 3,
          "AttachmentRestrictMime": true,
          "AttachmentRestrictType": true,
          "AutoName": true,
          "CalcMarkUpFromOEM": true,
          "ClaimantTypeEnabled": true,
          "IsThirdParty": true,
          "MandateVINRegSearch": true,
          "ManualEstimateEnabled": true,
          "PearlescentUpliftPcnt": 12.1,
          "PearlRateEditAllowed": true,
          "PNETEnabled": true,
          "ReferenceSequence": 15,
          "SignatureEnabled": true,
          "UserStatusNotEditable": true,
          "UserType": "Uninitialised",
          "WriteOffIndEnabled": true,
          "WriteOffPercentage": 19.1
        }
      }
    },
    "HasCriticalChange": true,
    "PartsPricesUpdated": true,
    "ValidationStatus": "Ok",
    "Message": [
      "sample string 1",
      "sample string 2"
    ],
    "VINClassicResult": {
      "ReturnCode": "Ok",
      "ReturnMessage": "sample string 1",
      "VINData": [
        {
          "VINNumber": "sample string 1",
          "ManufacturerCode": "sample string 2",
          "ModelCode": "sample string 3",
          "SubModelCode": "sample string 4",
          "DoorCode": "sample string 5",
          "EngineCode": "sample string 6",
          "DateCode": "sample string 7",
          "Make": "sample string 8",
          "Model": "sample string 9",
          "Colour": "sample string 10",
          "BodyStyle": "sample string 11",
          "EngineSize": "sample string 12",
          "FuelType": "sample string 13",
          "Transmission": "sample string 14",
          "DateFirstRegistered": "sample string 15",
          "VehicleType": "Uninitialised",
          "Registration": "sample string 16"
        },
        {
          "VINNumber": "sample string 1",
          "ManufacturerCode": "sample string 2",
          "ModelCode": "sample string 3",
          "SubModelCode": "sample string 4",
          "DoorCode": "sample string 5",
          "EngineCode": "sample string 6",
          "DateCode": "sample string 7",
          "Make": "sample string 8",
          "Model": "sample string 9",
          "Colour": "sample string 10",
          "BodyStyle": "sample string 11",
          "EngineSize": "sample string 12",
          "FuelType": "sample string 13",
          "Transmission": "sample string 14",
          "DateFirstRegistered": "sample string 15",
          "VehicleType": "Uninitialised",
          "Registration": "sample string 16"
        }
      ]
    },
    "VINPlusResult": {
      "ResultCode": "OK",
      "Message": "sample string 1",
      "VIN": "sample string 2",
      "Manufacturer": "sample string 3",
      "Model": "sample string 4",
      "Submodel": "sample string 5",
      "ModelOptions": "sample string 6",
      "Version": "sample string 7",
      "OriginalCode": "sample string 8",
      "ResultMessage": "sample string 9",
      "UnsupportedOptions": "sample string 10",
      "QueryId": "sample string 11",
      "PaintCode": "sample string 12",
      "VehicleType": "Uninitialised"
    },
    "VinPlusUsageMustBeConfirmed": true
  },
  "ErrorMessage": "sample string 2",
  "Exception": "sample string 3"
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.