Auctioning Data Instances

Once you have a Data Specification and a Data Source you are able to auction Data Instances via the API.

Given the example Data Specification, a Data Instance can be auctioned as follows:

curl -L 'https://app.bidzenith.com/v1/auction/01ARZ3NDEKTSV4RRFFQ69G5FAV' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "dataInstance": {
    "dataSpecificationId": "01BX5ZZKBKACTAV9WEVGEMMVS0",
    "properties": [
      {
        "name": "Name",
        "value": {
          "nameValue": {
            "title": "Mr",
            "firstName": "John"
            "lastName": "Doe"
          }
        }
      },
      {
        "name": "Email",
        "value": { "textValue": "[email protected]" }
      },
      {
        "name": "Telephone",
        "value": { "textValue": "0412345678" }
      },
      {
        "name": "Address",
        "value": {
          "addressValue": {
            "line1": "1 High Street",
            "townCity": "Sydney",
            "region": "New South Wales",
            "postcode": "2000",
            "countryCode": "AU"
          }
        }
      },
      {
        "name": "DateOfBirth",
        "value": { "dateValue": "1980-09-27 00:00:00.000" }
      },
      {
        "name": "HomeValue",
        "value": { "intValue": 650000 }
      },
      {
        "name": "MortgageValue",
        "value": { "intValue": 325000 }
      },
      {
        "name": "Term",
        "value": { "intValue": 15 }
      },
      {
        "name": "Occupation",
        "value": { "singleSelectValue": "Skilled" }
      },
      {
        "name": "BadCredit",
        "value": { "boolValue": false }
      },
      {
        "name": "CallPreference",
        "value": { 
          "timeOfDayValue": {
            "hours": 15,
            "minutes": 0,
            "seconds": 0,
            "nanos": 0
          }
        }
      }
    ]
  }
}'

If the Data Instance was successfully auctioned, the response would indicate the winner, monetary value and other metadata:

{
  "timestamp": "2024-07-29T15:51:28.071Z",
  "dataInstanceId": "01BX5ZZKBKACTAV9WEVGEMMVS1",
  "results": [
    {
      "campaignId": "01BX5ZZKBKACTAV9WEVGEMMVS0",
      "metadata": "CampaignMetadata1",
      "amount": {
        "currencyCode": "AUD",
        "units": "12",
        "nanos": 0
      }
    }
  ],
  "sold": true
}