Smart Data Audit
Description
The Smart Data Audit API can be used to get detailed information about report data returned as part of the data inquiry response. The audit data can be retrieved using the report_id returned as part of the submit transaction. The Smart Data Audit API will return the details about every data element provisioned as part of the data package.
Authentication
Step 1: Obtain a Bearer Token
The Smart Data API uses the Authenticate API to obtain a bearer token using your client_id and client_secret. This bearer token can be used to authenticate requests using the Smart Data API.
Step 2: Access the Smart Data Audit API
Audit URL: Get the audit for all the data points as part of the data package
Endpoint
Staging
POST https://api-smartdata.di-beta.boldpenguin.com/audit/v1/report/triangulation
Production
POST https://api.ii.boldpenguin.com/audit/v1/report/triangulation
Pass the following variables as part of the request
| Request Parameters | Comments |
|---|---|
| Authentication Token | The token obtained in STEP 1 |
| API Key | (Shared with the Customer) |
| POST Request Body | Data_package_id: (Shared with Customer) |
| Report_id: | (Returned as part of the company submit response) |
| Tenant_id: | (Shared with Customer) |
The response from the audit will contain the audit_response list which will
have details for every data element in the data package. The following are the audit details for every data element.
| Response Parameters | Comments |
|---|---|
| data_element_id | UniqueId for the data element |
| data_element_name | The business name for the data element |
| data_type | This is a meta data element that defines the value of the data element. |
| The value of the field could be Standard | Triangulated / Derived |
| destination_path | The json path in the response |
| value | The triangulated value for the data element |
| data_sources | The list of data sources which were crawled. The aggregate contains the data source names which returned the final value |
Sample Smart Data Audit API Request
POST /audit/v1/report/triangulation HTTP/1.1
Host: api-smartdata.di-beta.boldpenguin.com
x-api-key: M4jHKvQ6dD4Y1sDiv7gEe6LIuqArhDin8XldfxoK
Authorization: Bearer NMav128jTZbbEK48o64UM94K
Content-Type: application/json
Content-Length: 128
{
"data_package_id": "workfusion-us-c0001",
"report_id": "CUSDD97T2FAE114E52240",
"tenant_id": "workfusion"
}
Sample Smart Data Audit Response
{
"tx_id": "workfusion-b64dc748-48ec-4862-b62d-cb034db39ddc",
"tx_time": "2021-09-16T18:35:56.734Z",
"data_package_id": "workfusion-us-c0001",
"report_id": "CUSDD97T2FAE114E52240",
"status": "SUCCESS",
"audit_response": [
{
"data_element_id": "S-C000011",
"data_element_name": "State",
"data_type": "Triangulated",
"destination_path": "state",
"value": "OH",
"data_sources": [
"DNB",
"YP",
"SMD_SEED_DATA"
]
},
{
"data_element_id": "S-C000033",
"data_element_name": "Annual Revenue",
"data_type": "Triangulated",
"destination_path": "annual_revenue",
"value": "500.0",
"score": "80.64",
"data_sources": [
"DNB"
]
},
{
"data_element_id": "S-C000010",
"data_element_name": "City",
"data_type": "Triangulated",
"destination_path": "city",
"value": "Columbus",
"data_sources": [
"DNB",
"SMD_SEED_DATA"
]
},
{
"data_element_id": "S-C000035",
"data_element_name": "Total Full Time Employees",
"data_type": "Triangulated",
"destination_path": "total_full_time_employees",
"value": "250",
"score": "80.64",
"data_sources": [
"DNB"
]
},
{
"data_element_id": "S-C000012",
"data_element_name": "Postal Code",
"data_type": "Triangulated",
"destination_path": "postal_code",
"value": "43215",
"data_sources": [
"DNB",
"YP",
"SMD_SEED_DATA"
]
},
{
"data_element_id": "S-C000034",
"data_element_name": "Annual Payroll",
"data_type": "Triangulated",
"destination_path": "annual_payroll",
"score": "80.64"
},
{
"data_element_id": "S-C000037",
"data_element_name": "Total Employees at this Location",
"data_type": "Standard",
"destination_path": "total_employees_at_this_location",
"value": "250",
"score": "80.64",
"data_sources": [
"DNB"
]
},
{
"data_element_id": "S-C000014",
"data_element_name": "DUNS #",
"data_type": "Triangulated",
"destination_path": "duns_number",
"value": "123456789",
"data_sources": [
"DNB"
]
},
{
"data_element_id": "S-C001049",
"data_element_name": "Parent Company Revenue ISO Currency Code",
"data_type": "Standard",
"destination_path": "parent_company_revenue_currency_code",
"value": "USD",
"data_sources": [
"DNB"
]
},
{
"data_element_id": "S-C000031",
"data_element_name": "Year Founded",
"data_type": "Triangulated",
"destination_path": "year_founded",
"value": "2016",
"score": "82.96",
"data_sources": [
"OPENCORPORATES"
]
},
{
"data_element_id": "S-C000019",
"data_element_name": "Primary NAICS Description(2017)",
"data_type": "Triangulated",
"destination_path": "primary_naics_2017[].desc",
"value": [
"general freight trucking, local"
],
"score": "75.59",
"data_sources": [
"DNB"
]
},
{
"data_element_id": "S-C000018",
"data_element_name": "Primary NAICS Code(2017)",
"data_type": "Triangulated",
"destination_path": "primary_naics_2017[].code",
"value": [
"484110"
],
"score": "75.59",
"data_sources": [
"DNB"
]
},
{
"data_element_id": "S-C000441",
"data_element_name": "Primary NAICS Code (2012)",
"data_type": "Triangulated",
"destination_path": "primary_naics_2012[].code",
"value": [
"484110"
],
"score": "75.59",
"data_sources": [
"DNB"
]
}
{
"data_element_id": "S-C001035",
"data_element_name": "Parent Company Revenue",
"data_type": "Standard",
"destination_path": "parent_company_revenue"
},
{
"data_element_id": "S-C000021",
"data_element_name": "Secondary NAICS Description(2017)",
"data_type": "Triangulated",
"destination_path": "secondary_naics_2017[].desc",
"value": [
"Storage Battery Manufacturing",
"Motor Home Manufacturing",
"Reinsurance Carriers"
],
"score": "",
"data_sources": []
},
{
"data_element_id": "S-C000001",
"data_element_name": "Company ID",
"data_type": "Standard",
"destination_path": "company_id",
"value": "CUSDD97T2FAE114E52240",
"data_sources": [
"SMD_SEED_DATA"
]
},
{
"data_element_id": "S-C000004",
"data_element_name": "DBA/AKA",
"data_type": "Triangulated",
"destination_path": "dba_aka",
"value": [
"Bold Penguin"
],
"data_sources": [
"YP"
]
},
{
"data_element_id": "S-C000003",
"data_element_name": "Company Name",
"data_type": "Standard",
"destination_path": "company_name",
"value": "Bold Penguin",
"data_sources": [
"SMD_SEED_DATA"
]
},
{
"data_element_id": "S-C000006",
"data_element_name": "Phone Number",
"data_type": "Triangulated",
"destination_path": "phone_number",
"value": "(614) 344-1029",
"data_sources": [
"YP"
]
},
{
"data_element_id": "S-C000008",
"data_element_name": "Email ID",
"data_type": "Standard",
"destination_path": "email_id"
},
{
"data_element_id": "S-C000007",
"data_element_name": "Website",
"data_type": "Triangulated",
"destination_path": "website"
},
{
"data_element_id": "S-C000009",
"data_element_name": "Address",
"data_type": "Triangulated",
"destination_path": "address",
"value": "100 East Broad St",
"data_sources": [
"DNB",
"SMD_SEED_DATA"
]
}
]
}