Validate Device

Request Path

POST /api/device/validate

Request Object

This API consumes a JSON object with the following properties.

Property	Type	Description
*partnerId*	String	ID provided by Bluefin for access to the Decryptx API.
*partnerKey*	String	API Key provided by Bluefin for access to the Decryptx API. This value can be changed on request from the partner or by the partner via the Decryptx portal.
*reference (optional)*	String	A string (of up to 50 characters) that helps partners identify individual API calls. If provided, the value will be logged to the P2PE Manager where it can be used to troubleshoot technical issues. It is highly recommended that a unique value be used on each Decryptx API call. The reference value will be returned in the response body, whether the API call is successful or not.
*serial*	String	The serial number of the device.
*firmware*	String	The firmware version of the device as captured from the read.
*clientId*	String	Identifier for the partner client this device belongs to. This value is configured by the partner when the device is provisioned and is optional. This parameter provides an additional level of uniqueness in case device serial numbers are not unique between manufacturers. It also provides a more detailed level of reporting as API usage can be reported to the client level. All devices provisioned for a partner must have a unique combination of serial number and client. If a partner does not wish to use a client identifier, all devices provisioned for that partner must have a unique serial number.

Response Object

A successful API call outputs a JSON object with the following properties.

Property	Type	Description
*success*	Boolean	Indicates if validation was successful or not.
*reference*	String	A string (of up to 50 characters) that helps partners identify individual API calls. If provided, the value will be logged to the P2PE Manager where it can be used to troubleshoot technical issues. It is highly recommended that a unique value be used on each Decryptx API call. The reference value will be returned in the response body, whether the API call is successful or not.
*messageId*	String	Bluefin assigned unique identifier for each response from the Decryptx API. This can and should be stored for troubleshooting purposes. This will be 25 numeric characters.

cURL Example

curl 'https://secure-cert.decryptx.com/api/device/validate' \
    -X POST \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    -d '{
            "partnerId"  : "WATERFORD",
            "partnerKey" : "ef1ad938150fb15a1384b883a104ce70",
            "reference"  : "723f57e1-e9c8-48cb-81d9-547ad2b76435",
            "serial"     : "541T112708",
            "clientId"   : "bobs_burgers"
        }'

//If the device is setup correctly, you will get a response similar to the following:

{
  "success"   : true,
  "reference" : "723f57e1-e9c8-48cb-81d9-547ad2b76435",
  "messageId" : "1201607010032461023979379"
}