Auto pairing

If the Auto pairing configuration is enabled for an organization, when a unit is installed to an asset and begins communicating, the auto pairing of the unit to the asset happens in SCALAR, based on the VIN configured in the TBS/EBS.

Event Structure

The auto pairing event structure includes the following fields.

Field	Description
eventBatchId	The unique identifier of the event batch.
eventSubscriptionId	The unique identifier of the event subscription.
eventBatchTime	The timestamp at which the event batch is generated.
eventsData	Array of events generated in the batch.
eventType	Type of the event.
eventVersion	Version of the event.
eventData.registeredOn	The timestamp at which the pairing is initiated.
eventData.organizationId	The unique identifier of the organization for which the event belongs to.
eventData.assetId	The unique identifier of the asset.
eventData.unitId	The unique identifier specifying a unit with unit type and serial number.
eventData.status	The status of the pairing of the unit with the asset in the system.
eventData.reason	Reason for the asset pairing.
eventData.assetVIN	The VIN entered in the asset management module of SCALAR.
eventData.sensorVIN	The VIN received from the communication unit, configured in the TBS/EBS.
eventData.candidateAssetIds	Array of asset Id that partially match the sensorVIN.
eventData.location	The location information containing latitude and longitude.

Success Scenario

When the auto pairing process completes successfully, the communication unit is paired with the asset based on the VIN match.

Example:

{
	"eventBatchId": "31fccdce-725e-4c87-a91b-3a8e66144641",
	"eventSubscriptionId": "41634ca6-a7fb-4dc2-9461-7e9b24be885e",
	"eventBatchTime": "2025-05-13T13:18:13.2017310Z",
	"eventsData": [
	{
		"eventType": "unit.paired",
		"eventVersion": 1,
		"eventData": {
			"registeredOn": "2025-05-12T22:20:00.000Z",
			"organizationId": "c8c90b90-ad39-4a3d-8b89-c25a22acaa25",
			"unitId": "tp:890123847562332",
			"status": "success",
			"reason": "AutoPair",
			"assetId": "5bca3b72-e006-4cea-bfaa-f5a4dcf3a63c",
			"assetVIN": "1HGCM82633A000001",
			"sensorVIN": "F3A000001",
			"location": {
				"lat": 50.869,
				"lon": 2.8942
				}
			}
		}
	]
}

Failure scenario

When the auto pairing process fails, the communication unit is not paired with the asset due to various reasons, such as invalid data, not found, multiple matches, or unknown errors.

Invalid Data - Description/Reason

This could be because the VIN provided does not match any asset in the system or the data format is incorrect.

Example:

{
	"eventBatchId": "31fccdce-725e-4c87-a91b-3a8e66144641",
	"eventSubscriptionId": "41634ca6-a7fb-4dc2-9461-7e9b24be885e",
	"eventBatchTime": "2025-05-13T13:18:13.2017310Z",
	"eventsData": [
		{
			"eventType": "unit.paired",
			"eventVersion": 1,
			"eventData": {
				"registeredOn": "2025-05-12T22:20:00.000Z",
				"organizationId": "c8c90b90-ad39-4a3d-8b89-c25a22acaa25",
				"unitId": "tp:890123847562332",
				"status": "failed",
				"reason": "InvalidData",
				"location": {
					"lat": 50.869,
					"lon": 2.8942
				}
			}
		}
	]
}

Not Found - Description/Reason, Example

When the VIN does not match (exactly or partially) against any of the assets, a "Not Found" scenario occurs. In this case, the failure event is sent every hour for 48 hours to prompt the customer or user to take immediate action to perform a successful pairing.

Example:

{
	"eventBatchId": "31fccdce-725e-4c87-a91b-3a8e66144641",
	"eventSubscriptionId": "41634ca6-a7fb-4dc2-9461-7e9b24be885e",
	"eventBatchTime": "2025-05-13T13:18:13.2017310Z",
	"eventsData": [
		{
			"eventType": "unit.paired",
			"eventVersion": 1,
			"eventData": {
				"registeredOn": "2025-05-12T22:20:00.000Z",
				"organizationId": "c8c90b90-ad39-4a3d-8b89-c25a22acaa25",
				"unitId": "tp:890123847562332",
				"status": "failed",
				"reason": "NotFound",
				"sensorVIN": "F3A000001",
				"location": {
					"lat": 50.869,
					"lon": 2.8942
				}
			}
		}
	]
}

Multiple Match Found - Description/Reason, Example

When the VIN is matched partially with more than one asset, a "Multiple Match Found" scenario arises.

Example:

{
	"eventBatchId": "31fccdce-725e-4c87-a91b-3a8e66144641",
	"eventSubscriptionId": "41634ca6-a7fb-4dc2-9461-7e9b24be885e",
	"eventBatchTime": "2025-05-13T13:18:13.2017310Z",
	"eventsData": [
		{
			"eventType": "unit.paired",
			"eventVersion": 1,
			"eventData": {
				"registeredOn": "2025-05-12T22:20:00.000Z",
				"organizationId": "c8c90b90-ad39-4a3d-8b89-c25a22acaa25",
				"unitId": "krone:890123847562332",
				"status": "failed",
				"reason": "MultipleMatchFound",
				"sensorVIN": "F3D000001",
				"candidateAssetIds": [
					"c8c90b90-ad39-4a3d-8b89-c25a22acaa25",
					"d8d90d90-dd29-3d3d-3b89-c45a22acab34"
				],
				"location": {
					"lat": 50.869,
					"lon": 2.8942
				}
			}
		}
	]
}

Unknown - Description/Reason, Example

Description/Reason: When a system error occurs unexpectedly and the pairing is not performed, an "Unknown" error is sent in the event.

Example:

{
	"eventBatchId": "31fccdce-725e-4c87-a91b-3a8e66144641",
	"eventSubscriptionId": "41634ca6-a7fb-4dc2-9461-7e9b24be885e",
	"eventBatchTime": "2025-05-13T13:18:13.2017310Z",
	"eventsData": [
		{
			"eventType": "unit.paired",
			"eventVersion": 1,
			"eventData": {
				"registeredOn": "2025-05-12T22:20:00.000Z",
				"organizationId": "c8c90b90-ad39-4a3d-8b89-c25a22acaa25",
				"unitId": "txtrailerguard:359315075384726",
				"status": "failed",
				"reason": "Unknown",
				"sensorVIN": "F3D000001",
				"location": {
					"lat": 50.869,
					"lon": 2.8942
				}
			}
		}
	]
}