Scraped

A Scraped object represents the result of a processed vehicle. The contents of this object can vary depending on the resource type on which the vehicle has been processed. For example, if the vehicle has been processed under a specific resource type, such as fines, the "Result" property within the scraped object will specifically contain information related to that resource type, such as the tickets object.

Methods

The API supports the following methods for Scraped objects:

HTTP request	Description
GET processed vehicle	Returns processing results for a vehicle from all Sync resources.
GET processed vehicle by a specific state and resource type.	Returns the processing results for a vehicle based on a specified state and resource type.
GET processed vehicle for all resource types.	Returns the processing results for a vehicle for each Sync resource type.
GET processed vehicle by a specific resource type.	Returns the processing results for a vehicle based on a specified resource type.
GET processed vehicle batch.	Returns processing results for a vehicle from all Sync resources in which the vehicle has been processed.

Object representation

Scraped

{
    "creationDateTime": Date,
    "finishedDateTime"?: Date,
    "traceId"?: string,
    "vehicleInfo"?: VehicleInfo,
    "status"?: Status,
    "plate": string,
    "vin": string,
    "stateId": number,
    "resourceId": number,
    "username"?: string,
    "password"?: string,
    "callBack"?: string,
    "callBackMessage"?: string,
    "result"?: Result[],
    "evidenceURL"?: string[],
    "extraInfo"?: Record<string, unknown>,
    "parentCriteriaId"?: string,
    "parentBatchId"?: string
}

Properties	Type	Description
stateId	number	State identifier.
creationDateTime	Date	Date and time the vehicle was submitted for processing.
evidenceURL	string[]?	Contains the URLs of the images depicting the process followed to process the vehicle.
extraInfo	Record<string, any>	Contains additional information.
finishedDateTime	Date?	Time and date when the vehicle processing was completed.
password	string?	The encoded password used for processing in some resources that needs an account in the website.
plate	string	Vehicle plate.
resourceId	number	The resource identifier where the vehicle was sent for processing.
result	Result[]?	Collection of results. It contains information about the fines, owner taxes, etc.
traceId	string?	It is an identifier for errors. If this object appears, it indicates that the vehicle could not be processed.
username	string?	The encoded username used for processing in some resources that needs an account in the website.
vehicleInfo	VehicleInfo?	Vehicle information.
vin	string	Vehicle VIN.
callBack	string?	It is the URL of an endpoint. When the processing of a vehicle is completed, a request is made to that endpoint, and the obtained information is sent in the request body.
callBackMessage	string?	It is an identifier that serves to group multiple vehicles during processing and easily identify them.
status	Status?	Sync status of the vehicle.
parentCriteriaId	string?	Identifier that groups vehicles by a specific criteria (e.g., all vehicles scraped using the same tax identifier).
parentBatchId	string?	Identifier that groups vehicles by the batch process in which they were processed. Useful to track executions and associate multiple criteria processed together.

VehicleInfo

{
  "plate"?: string,
  "vin"?: string,
  "brand"?: string,
  "model"?: string,
  "year"?: number,
  "class"?: string,
  "type"?: string,
  "doors"?: number,
  "country"?: string,
  "variation"?: string,
  "cilinders"?: string,
  "axes"?: string,
  "assemblyPlant"?: string,
  "supplementaryData"?: string,
  "enrolledInstitution"?: string,
  "inscriptionDate"?: string,
  "inscriptionTime"?: string,
  "platingEntity"?: string,
  "platingDate"?: string,
  "registrationCertificateFolio"?: string,
  "observations"?: string,
  "color"?: string,
  "ownerName"?: string,
  "engineNumber"?: string
}

Properties	Type	Description
plate	string?	Vehicle's plate.
vin	string?	Vehicle Identification Number (VIN).
brand	string?	Brand of the vehicle.
model	string?	Model of the vehicle.
year	number?	Year of manufacture.
class	string?	Class of the vehicle.
type	string?	Type of the vehicle.
doors	number?	Number of doors.
country	string?	Country of origin.
variation	string?	Variation of the vehicle.
cilinders	string?	Number of cylinders.
axes	string?	Number of axes.
assemblyPlant	string?	Assembly plant.
supplementaryData	string?	Supplementary data.
enrolledInstitution	string?	Institution where the vehicle is enrolled.
inscriptionDate	string?	Date of inscription.
inscriptionTime	string?	Time of inscription.
platingEntity	string?	Entity responsible for plating.
platingDate	string?	Date of plating.
registrationCertificateFolio	string?	Folio of the registration certificate.
observations	string?	Additional observations.
color	string?	Color of the vehicle.
ownerName	string?	Name of the owner.
engineNumber	string?	Engine number.

Result

{
    "subTotal"?: number,
    "discount"?: number,
    "surcharge"?: number,
    "total"?: number,
    "pdfUrl": string,
    "paymentLine"?: string,
    "paymentLineDueDate"?: Date,
    "scrapedTickets"?: {
        "count": number,
        "tickets": Tickets[]?
    },
    "scrapedTenencias"?: {
        "count": number,
        "tenencias"?: Tenencias[]
    },
    "scrapedRefrendos"?: {
        "count": number,
        "refrendos"?: Refrendos[]
    },
    "scrapedStolen"?: {
        "stolenCount": number,
        "count": number,
        "stolen"?: Stolen[]
    },
    "scrapedInsurance"?: {
        "count": number,
        "insurance"?: Insurance[]
    },

    "scrapedTDC"?: {
        "count": number,
        "tdc"?: TDC[]
    },

    "scrapedInspection"?: {
        "count": number,
        "inspection"?: Inspection[]
    },

    "scrapedViolations"?: {
        "count": number,
        "violations"?: Violation[]
    },

    "scrapedPlateStatus"?: {
        "count": number,
        "plateStatus"?: PlateStatus[]
    }
}

Properties	Type	Description
subTotal	number?	Subtotal amount.
discount	number?	Discount amount.
surcharge	number?	Surcharge amount.
total	number?	Total amount.
pdfUrl	string	URL of the PDF document.
paymentLine	string?	Payment line.
paymentLineDueDate	Date?	Due date of the payment line.
scrapedTickets	object?	Information about vehicle fines.
scrapedTickets.count	number	Amount of vehicle fines.
scrapedTickets.tickets	Tickets[]?	Tickets collection.
scrapedTenencias	object?	Information about vehicle owner taxes.
scrapedTenencias.count	number	Number of owner taxes.
scrapedTenencias.tenencias	Tenencias[]?	Owner taxes collection.
scrapedRefrendos	object?	Information about vehicle registration renewal.
scrapedRefrendos.count	number	Number of vehicle registration renewals.
scrapedRefrendos.refrendos	Refrendos[]?	Vehicle registration renewal collection.
scrapedStolen	object?	Information about stolen vehicle records.
scrapedStolen.count	number	Number of consulted agencies (OCRA, PGJ, etc).
scrapedStolen.countStolen	number	Number of stolen reports.
scrapedStolen.stolen	Stolen[]?	Stolen reports collection.
scrapedTDC	object?	Information about vehicle registration cards.
scrapedTDC.count	number	Number of Vehicle registration cards.
scrapedTDC.tdc	TDC[]?	Vehicle registration cards collection.
scrapedInspection	object?	Scraped data of vehicle inspections.
scrapedInspection.count	number	Number of vehicle inspections found.
scrapedInspection.inspections	Inspection[]?	Collection of vehicle inspections.
scrapedViolations	object?	Scraped data of vehicle violations (unverified).
scrapedViolations.count	number	Number of violations found.
scrapedViolations.violations	Violation[]?	Collection of vehicle violations (unverified).

Tickets (Fines)

{
    "id"?: string,
    "subTotal": number,
    "description"?: string,
    "discountsSum": number,
    "surchargesSum": number,
    "total": number,
    "dateTime": Date,
    "images"?: string[],
    "discounts"?: [
        {
            "description": string,
            "total": number
        }
    ],
    "surcharges"?: [
        {
            "description": string,
            "total": number
        }
    ]
}

Properties	Type	Description
id	number?	Vehicle fine identifier.
subtotal	number	Fine amount without fine surcharges and discounts.
description	string?	Fine description.
discountsSum	number	The sum of the fines discounts.
surchargesSum	number	The sum of the fines surcharges.
total	number	Fine total amount with surcharges and discounts.
dateTime	Date	Date of the fine.
images	string[]?	Additional images.
surcharge	collection?	Surcharge collection.
surcharge[].description	string	Description of a surcharge for the fine.
surcharge[].total	number	Amount of a surcharge for the fine.
discount	collection?	Discount collection.
discount[].description	string	Description of a discount for the fine.
discount[].total	number	Amount of a discount for the fine.

Tenencias (Owner taxes)

{
    "description"?: string,
    "subTotal": number,
    "discountsSum": number,
    "surchargesSum": number,
    "total": number,
    "year"?: number,
    "discounts"?: [
        {
            "description": string,
            "total": number
        }
    ],
    "surcharges"?: [
        {
            "description": string,
            "total": number
        }
    ]
}

Properties	Type	Description
description	string?	Description of the owner taxes.
subtotal	number	Amount of owner taxes without surcharges and discounts.
discountsSum	number	Sum of the owner taxes discounts.
surchargesSum	number	Sum of the owner taxes surcharges.
total	number	Total amount of owner taxes with surcharges and discounts.
year	number?	Year of the owner taxes.
surcharges	object[]?	Collection of surcharges for the owner taxes.
surcharges[].description	string	Description of a surcharge.
surcharges[].total	number	Amount of a surcharge.
discounts	object[]?	Collection of discounts for the owner taxes.
discounts[].description	string	Description of a discount.
discounts[].total	number	Amount of a discount.

Refrendos

{
    "description"?: string,
    "subTotal": number,
    "discountsSum": number,
    "surchargesSum": number,
    "total": number,
    "year"?: number?,
    "discounts"?: [
        {
            "description": string,
            "total": number
        }
    ],
    "surcharges"?: [
        {
            "description": string,
            "total": number
        }
    ]
}

Properties	Type	Description
description	string?	Description of the vehicle registration renewal.
subtotal	number	Amount of the vehicle registration renewal without surcharges and discounts.
discountsSum	number	Sum of the discounts for the vehicle registration renewal.
surchargesSum	number	Sum of the surcharges for the vehicle registration renewal.
total	number	Total amount of the vehicle registration renewal with surcharges and discounts.
year	number?	Year of the vehicle registration renewal.
surcharges	object[]?	Collection of surcharges for the vehicle registration renewal.
surcharges[].description	string	Description of a surcharge.
surcharges[].total	number	Amount of a surcharge.
discounts	object[]?	Collection of discounts for the vehicle registration renewal.
discounts[].description	string	Description of a discount.
discounts[].total	number	Amount of a discount.

Stolen

{
    "agency": string,
    "stolen": boolean,
    "dateTime"?: Date,
    "entity"?: string,
    "updateDate"?: Date,
    "dateOfInquiry"?: Date,
    "recoveryEntity"?: string
}

Properties	Type	Description
agency	string	Agency where the theft was reported (e.g., OCRA, PGJ, etc.).
stolen	boolean	Indicates whether there are stolen reports in the agency or not.
dateTime	Date?	Date of theft.
entity	string?	The entity in which the theft was reported.
updateDate	Date?	Date of theft update.
dateOfInquiry	Date?	Date of theft investigation
recoveryEntity	string?	Recovery entity, if applicable.

Insurance

{
    "policy": string,
    "startDateTime"?: Date,
    "finishDateTime"?: Date
}

Properties	Type	Description
policy	string	Vehicle insurance policy identifier.
startDateTime	Date?	Start date of the vehicle insurance policy.
finishDateTime	Date?	Expiration date of the vehicle insurance policy.

TDC

{
    "id"?: string,
    "validity"?: Date,
    "stamp"?: string
}

Properties	Type	Description
id	string?	Identifier of the vehicle registration card query date.
validity	Date?	Validity date of the vehicle registration card.
stamp	string?	Digital seal.

Inspection

{
    "certificateId"?: string,
    "inspectionType"?: string,
    "issuedDate"?: Date,
    "expiresDate"?: Date,
    "inspectionCenter"?: string,
    "currentlyValid"?: string,
    "dataIntegrityConfirmed"?: string
}

Properties	Type	Description
certificateId	string?	Identifier of the vehicle inspection.
inspectionType	string?	Type of the vehicle inspection.
issuedDate	Date?	Date of the vehicle inspection.
expiresDate	Date?	Expiration date of the vehicle inspection.
inspectionCenter	string?	Inspection center.
currentlyValid	string?	If inspection is valid or not.
dataIntegrityConfirmed	string?	If data integrity is confirmed or not.

Violations

{
    "id"?: string,
    "description"?: string,
    "subTotal"?: number,
    "discountsSum"?: number,
    "surchargesSum"?: number,
    "total"?: number,
    "dateTime"?: Date,
    "notificationDate"?: Date,
    "organism"?: string,
    "organismIdentifier"?: string,
    "type"?: string,
    "sourceType"?: string,
    "direction"?: string,
    "municipality"?: string,
    "isElectronic"?: boolean,
    "status"?: string,
    "images"?: string[],
    "discounts"?: [
        {
            "description": string,
            "total": number
        }
    ],
    "surcharges"?: [
        {
            "description": string,
            "total": number
        }
    ]
}

Properties	Type	Description
id	string?	Identifier of the vehicle violation.
description	string?	Description of the violation.
subTotal	number?	Amount of the violation without surcharges and discounts.
discountsSum	number?	Total amount of all discounts applied.
surchargesSum	number?	Total amount of all surcharges applied.
total	number?	Final amount of the violation after surcharges and discounts.
dateTime	string?	Date of the violation (ISO 8601 format).
notificationDate	string?	Date of the notification (ISO 8601 format).
organism	string?	Authority that reported the violation.
organismIdentifier	string?	Identifier of the authority that reported the violation.
type	string?	Type/category of the violation.
sourceType	string?	Type of source that reported the violation.
direction	string?	Location or direction related to the violation.
municipality	string?	Municipality where the violation was reported.
isElectronic	boolean	Indicates if the violation was issued electronically.
status	string?	Status of the violation.
images	string[]	URLs of images related to the violation.
surcharges	object[]?	Collection of surcharges for the violation.
surcharges[].description	string	Description of a surcharge.
surcharges[].total	number	Amount of a surcharge.
discounts	object[]?	Collection of discounts for the violation.
discounts[].description	string	Description of a discount.
discounts[].total	number	Amount of a discount.

PlateStatus

{
    "id"?: string,
    "startDateTime"?: Date,
    "finishDateTime"?: Date,
    "previousPlate"?: string,
    "status"?: string
}

Properties	Type	Description
id	string?	Identifier of the vehicle plate status if any.
startDateTime	Date?	Start date of the vehicle plate status.
finishDateTime	Date?	Expiration date of the vehicle plate status.
previousPlate	string?	Previous plate of the vehicle plate if any.
status	string?	Status of the vehicle plate given by the portal.