DataFileBatch Email Verification

The samples provided are representative of what may be returned in responses. In order to provide comprehensive samples, some values were added where the actual response had null or no values.

In addition, values in both requests and responses have been "faked" or modified to protect potentially private data (e.g., phone number) where applicable. Therefore, using requests exactly as is may not return any results.

Contents

• Post Request
• Post Response
• Get By ID Request
• Get By ID Response (Processing)
• Get By ID Response (Processed)

DataFileBatch

Post Request

POST https://plus.dnb.com/v1/dataFileBatch
{
	"process": "EmailVerification",
	"customerReference": "QA2EVsanity",
	"customerTransactionID": "61we2e34567ZipemailTest",
	"customerKey": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI=",
	"inputSpecification": {
		"fileName": "EVdemo",
		"recordLayout": "Flat-File",
		"recordDelimiter": "CRLF",
		"encoding": "UTF-8",
		"characterSet": "Unicode",
		"enclosingCharacter": "\"",
		"enclosingMode": "MINIMAL"
	},
	"outputSpecification": {
		"recordLayout": "Flat-File",
		"recordDelimiter": "CRLF",
		"fieldDelimiter": "$",
		"enclosingCharacter": "\"",
		"enclosingMode": "MINIMAL",
		"encoding": "UTF-8",
		"characterSet": "Unicode"
	},
	"notificationDetail": {
		"emailAddress": "test@dnb.com"
	},
	"emailVerificationSpecification": {
		"isDetailVerificationRequired": false
	}
}

Post Response

{
	"transactionDetail": {
		"customerTransactionID": "61we2e34567ZipemailTest",
		"transactionID": "rrt-0f952ef13aa4af7b7-b-ea-8580-153273473-1",
		"transactionTimestamp": "2022-12-09T07:05:51.471Z",
		"inLanguage": "en-US",
		"serviceVersion": "1"
	},
	"inquiryDetail": {
		"process": "EmailVerification",
		"inputSpecification": {
			"recordDelimiter": "CRLF",
			"recordLayout": "Flat-File",
			"fileName": "test.zip",
			"encoding": "UTF-8",
			"characterSet": "Unicode",
			"enclosingCharacter": "\"",
			"enclosingMode": "MINIMAL"
		},
		"outputSpecification": {
			"recordDelimiter": "CRLF",
			"recordLayout": "Flat-File",
			"fieldDelimiter": "|",
			"escapeCharacter": "'",
			"hasHeader": true,
			"compressionType": "gzip",
			"encoding": "UTF-8",
			"characterSet": "Unicode",
			"enclosingCharacter": "\"",
			"enclosingMode": "MINIMAL"
		},
		"customerReference": "6emailTest.txt.gzcustomerReference19",
		"customerKey": "",
		"notificationDetail": {
			"emailAddress": "test@test.com"
		},
		"emailVerificationSpecification": {
			"isDetailVerificationRequired": true
		}
	},
	"batchID": "26b91190-4c91-4d8a-8a3a-a7435c47b221",
	"batchSubmissionDetail": {
		"contentURL": "http://www.someurl.com",
		"urlMethod": "PUT",
		"urlExpirationTimeStamp": "2022-12-10T07:05:51.454Z"
	}
}

Get By ID Request

GET https://plus.dnb.com/v1/dataFileBatch/26b91190-4c91-4d8a-8a3a-a7435c47b221

Get By ID Response (Processing)

{
	"transactionDetail": {
		"customerTransactionID": "",
		"transactionID": "rrt-0da49783b2e75434a-d-ea-26562-98347800-1",
		"transactionTimestamp": "2022-12-09T07:11:17.448Z",
		"inLanguage": "en-US",
		"serviceVersion": "1"
	},
	"inquiryDetail": {
		"batchID": "26b91190-4c91-4d8a-8a3a-a7435c47b221"
	},
	"batchDetail": {
		"batchID": "26b91190-4c91-4d8a-8a3a-a7435c47b221",
		"process": "EmailVerification",
		"customerKey": "",
		"customerReference": "6emailTest.txt.gzcustomerReference19",
		"batchResultSummary": {
			"inputCount": 10,
			"successCount": "",
			"failureCount": ""
		},
		"batchExecutionTimeSummary": {
			"requestCreatedTimestamp": "2022-12-09T07:05:51.456093",
			"fileReceivedTimestamp": "2022-12-09T07:08:06.802821",
			"processStartTimestamp": "2022-12-09T07:08:08.349818",
			"processCompletionTimestamp": "2022-12-09T07:11:15.769627"
		},
		"inputSpecification": {
			"recordDelimiter": "CRLF",
			"recordLayout": "Flat-File",
			"fileName": "test.zip"
		},
		"outputSpecification": {
			"hasHeader": true,
			"escapeCharacter": "'",
			"compressionType": "gzip",
			"fieldDelimiter": "|",
			"recordDelimiter": "CRLF",
			"recordLayout": "Flat-File"
		},
		"notificationDetail": {
			"emailAddress": "test@test.com"
		},
		"emailVerificationSpecification": {
			"isDetailVerificationRequired": true
		},
		"batchResult": {
			"code": "60102",
			"message": "Processing"
		}
	}
}

Get By ID Response (Processed)

{
	"transactionDetail": {
		"customerTransactionID": "",
		"transactionID": "rrt-0da49783b2e75434a-d-ea-26562-98347800-1",
		"transactionTimestamp": "2022-12-09T07:11:17.448Z",
		"inLanguage": "en-US",
		"serviceVersion": "1"
	},
	"inquiryDetail": {
		"batchID": "26b91190-4c91-4d8a-8a3a-a7435c47b221"
	},
	"batchDetail": {
		"batchID": "26b91190-4c91-4d8a-8a3a-a7435c47b221",
		"process": "EmailVerification",
		"customerKey": "",
		"customerReference": "6emailTest.txt.gzcustomerReference19",
		"batchResultSummary": {
			"inputCount": 10,
			"successCount": "",
			"failureCount": ""
		},
		"batchExecutionTimeSummary": {
			"requestCreatedTimestamp": "2022-12-09T07:05:51.456093",
			"fileReceivedTimestamp": "2022-12-09T07:08:06.802821",
			"processStartTimestamp": "2022-12-09T07:08:08.349818",
			"processCompletionTimestamp": "2022-12-09T07:11:15.769627"
		},
		"inputSpecification": {
			"recordDelimiter": "CRLF",
			"recordLayout": "Flat-File",
			"fileName": "test.zip",
			"encoding": "UTF-8",
			"characterSet": "Unicode",
			"enclosingCharacter": "\"",
			"enclosingMode": "MINIMAL"
		},
		"outputSpecification": {
			"hasHeader": true,
			"escapeCharacter": "'",
			"compressionType": "gzip",
			"fieldDelimiter": "|",
			"recordDelimiter": "CRLF",
			"recordLayout": "Flat-File",
			"encoding": "UTF-8",
			"characterSet": "Unicode",
			"enclosingCharacter": "\"",
			"enclosingMode": "MINIMAL"
		},
		"notificationDetail": {
			"emailAddress": "test@test.com"
		},
		"emailVerificationSpecification": {
			"isDetailVerificationRequired": true
		},
		"outputDetail": {
			"contentURL": "http://www.someurl.com",
			"urlMethod": "GET",
			"urlExpirationTimestamp": "2022-12-10T07:09:52.290Z"
		},
		"batchResult": {
			"code": "60104",
			"message": "Processed"
		}
	}
}