Loading

Direct 2.0
Collapse

List Portfolio Asset

ProductsD&B Direct 2.0, D&B Direct Onboard
Product Code(s)Not Applicable
Options(s)None
Monitoring AvailableNo
InterfaceREST
MethodGET
Format(s)JSON
ServicePortfolio
{version}2.0
Initial ReleaseOctober 3, 2013

Provides a list of previously ordered products that have not yet expired.

Update History

  • January 29, 2016 (v.2.0 SOAP & REST): The attributes InvestigationStatusText @DNBCodeValue and InvestigationStatusText @DNBCodeTableNumber are removed from ListPortfolioAsset. The possible values for InvestigationStatusText are updated.

Feature Request

IMPORTANT: Please see the new Online Services Security Enhancement Release, effective December 14, 2018.

Overview

D&B Direct customers are assigned a temporary storage area where copies of the data and report products requested via the API can be retained for 120 days (extendable up to 365 days or remaining length of the current contract, whichever is less). This portfolio feature provides a convenient way to retrieve previously accessed information for comparison or recovery purposes.

When the archiving option is selected, a portfolio asset ID is returned by requests for a D&B Direct data or report product. This asset ID can be used to retrieve the copied information from the portfolio. Alternatively, a separate service exists that can be used to obtain a list of the portfolio contents.

Three operations (List, Retrieve and Delete) are provided to access and manage the information contained in the Product Request Archive.

Data Layer Entitlement

For customers in U.S. and Canadian markets, the API is provisioned for specific collections of products, reports, and/or features (collectively referred to as data layers) for production and trial usage. Entitlement is not required for testing in the sandbox environment.

  • This particular feature does not require entitlement for production and trial usage for D&B Direct 2.0 customers.

For customers in the UK, Ireland, Belgium, Netherlands and Luxembourg markets, the API is provisioned as a specific set of data layers for production, trial, and sandbox usage.

  • This particular data layer is included in the D&B Direct Onboard 2.0 suite.

Specification

Sample Request (List)
https://direct.dnb.com/V2/assets?OrderToTimestamp=2013-10-01T00%3A00%3A00Z&OrderFromTimestamp=2013-05-01T00%3A00%3A00Z
Authorization: <MyToken>
Name Characteristics
StreetAddressLine-n string up to 240 chars., Optional
PrimaryTownName string up to 64 chars., Optional
CountryISOAlpha2Code string at least 2 chars. up to 2 chars., Optional
TerritoryName string up to 64 chars., Optional
FullPostalCode string up to 32 chars., Optional
CountyName string up to 64 chars., Optional
TelephoneNumber (format internationaldialing code-TelecommunicationNumber) string at least 1 chars. up to 50 chars., Optional

A sequence of digits used by the subject for voice communication in a public switched telephone network. This sequence of digits includes the area code or city code. Note: This number does not include the International Dialing Code and Domestic Dialing Code.

DNBProductID string up to 64 chars., Optional
InquiryApplicationTransactionID string up to 64 chars., Optional
OrderTransactionTypeCode integer up to 7 digits., Optional

A set of codes that identifies different types of requests that a customer can place with D&B, e.g., Product Order, Investigation Order.

Possible values: 0-Report/Product; 1- Investigations; 2- Both

OrderFromTimestamp dateTime, Optional
OrderToTimestamp dateTime, Optional
FulfillmentFromTimestamp dateTime, Optional
FulfillmentToTimestamp dateTime, Optional
InvestigationTrackingID InvestigationTrackingID at least 1 chars. up to 50 chars., Optional
InvestigationStatusCode integer up to 7 digits., Optional

Possible values: 0- Pending; 1- Fulfilled; 3- Cancelled

ShowUserLevelRecordsIndicator boolean, Optional
GroupAdminReadIndicator boolean, Optional
ApplicationTransactionID string up to 64 chars., Optional
TransactionTimestamp dateTime, Optional
SubmittingOfficeID string up to 64 chars., Optional
DUNSNumber string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Optional
OrganizationName string up to 256 chars., Optional
OrganizationIdentificationNumber string at least 1 chars. up to 40 chars., Optional

A number assigned by an external body or by D&B which either uniquely identifies or helps to identify an organization.

UserReadIndicator boolean, Optional
InquiryCustomerReferenceText-n string at least 1 chars. up to 240 chars., Optional
InquiryCustomerBillingEndorsementText string at least 1 chars. up to 240 chars., Optional
GlobalDecisionMakerRiskPolicyRuleName string up to 64 chars., Optional
GlobalDecisionMakerRiskPolicyRuleVersionNumber string up to 5 chars., Optional
InquiryDUNSNumber string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Optional
InquiryLanguageCode integer up to 7 digits., Optional

A code that defines the language in which the requested product is required to be fulfilled.

IndividualFirstName string up to 64 chars., Optional

The given name of the individual. If this is not known then an initial may be supplied.

IndividualLastName string up to 64 chars., Optional

The portion of the individual's name usually presented at the end used to identify the members of a family.

IndividualFullName FullName up to 256 chars., Optional

Records the details of the Full Name of the Individual on which the Consumer report is Pulled (this is applicable only when archiving consumer reports)

KeywordText string up to 256 chars., Optional

The text based on which the key word search is done.

OperatingStatusText string up to 256 chars., Optional

Text describing this organization/s functional state / trading status, e.g. active, out of business, dormant.

Possible values: For US cases - 9077 [Out of business - Favourable]; 9076 [Out of business - Unfavourable]; 9074 [Active]; 403 [Out of business];

For CA cases - 9077 [Out of business - Favourable]; 9076 [Out of business - Unfavourable]; 9074 [Active];

Endpoint

Use the following endpoint for requesting this feature. The {version} is dependent on the underlying service delivering the response.

Endpoint (Portfolio)
GET https://direct.dnb.com/V{version}/assets

Testing

This operation will function the same regardless of the environment. Portfolio operation requests made in the D&B Direct sandbox (test) environment will return results based on any previous product calls performed using sandbox credentials.

Feature Response

NOTE: The D&B Direct REST implementation uses the BadgerFish approach for JSON with some minor variations.

Specification

The following is a list of the possible data fields returned by this operation in the JSON response. Samples are provided for testing successful and failed retrieval, and to demonstrate the basic layout of a response. The data returned in samples may not represent actual values that this feature will deliver.

NOTE: The D-U-N-S Number returned in the response will be a nine-digit zero-padded, numeric value.

Sample Response (List)
{
	"ListPortfolioAssetResponse": {
		"@ServiceVersionNumber": "",
		"TransactionDetail": {
			"ApplicationTransactionID": null,
			"ServiceTransactionID": "Id-f06c78e6527bb9030d1b110c-1",
			"TransactionTimestamp": "2013-11-07T11:00:03.951-05:00"
		},
		"TransactionResult": {
			"SeverityText": "Information",
			"ResultID": "CM000",
			"ResultText": "Success"
		},
		"ListPortfolioAssetResponseDetail": {
			"CandidateMatchedQuantity": 2,
			"CandidateReturnedQuantity": 2,
			"ListCandidate": [
				{
					"SubjectDetail": {
						"DUNSNumber": "003001070",
						"OrganizationPrimaryName": {
							"OrganizationName": {
								"$": "AIR PRODUCTS AND CHEMICALS, INC."
							}
						},
						"ReportOrderBy": "testdemo1@dnb.com",
						"PrimaryAddress": {
							"StreetAddressLine": {
								"LineText": "7201 HAMILTON BLVD"
							},
							"PrimaryTownName": "Allentown",
							"CountryISOAlpha2Code": "US",
							"TerritoryName": "PA",
							"FullPostalCode": "181959642"
						}
					},
					"OrderTimestamp": "2013-08-31T10:45:37.004-04:00",
					"ApplicationTransactionID": "Id-55bbcb1d5222018e050b742e-2",
					"Product": {
						"ArchiveDetail": {
							"ExtendArchivePeriodIndicator": false,
							"PortfolioAssetID": 27761607
						},
						"DNBProductID": "DCP_PREM",
						"UserReadIndicator": false,
						"GroupAdminReadIndicator": false,
						"ObjectAttachment": {
							"ObjectFormatTypeText": {
								"$": "XML"
							}
						}
					}
				}, {
					"SubjectDetail": {
						"DUNSNumber": "002568616",
						"OrganizationPrimaryName": {
							"OrganizationName": {
								"$": "Amboy Bank"
							}
						},
						"ReportOrderBy": "testdemo1@dnb.com",
						"PrimaryAddress": {
							"StreetAddressLine": {
								"LineText": "3590 US HIGHWAY 9"
							},
							"PrimaryTownName": "Old Bridge",
							"CountryISOAlpha2Code": "US",
							"TerritoryName": "NJ",
							"FullPostalCode": "088572765"
						}
					},
					"OrderTimestamp": "2013-08-31T11:25:29.012-04:00",
					"ApplicationTransactionID": "Id-92ab2bf752220ae70abbffff-2",
					"Product": {
						"ArchiveDetail": {
							"ExtendArchivePeriodIndicator": false,
							"PortfolioAssetID": 27763314
						},
						"DNBProductID": "DCP_STD",
						"UserReadIndicator": false,
						"GroupAdminReadIndicator": false,
						"ObjectAttachment": {
							"ObjectFormatTypeText": {
								"$": "XML"
							}
						}
					}
				}
			]
		}
	}
}
Name Characteristics
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { CandidateMatchedQuantity integer, up to 6 digits, Required
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { CandidateReturnedQuantity integer, up to 6 digits, Required
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate Aggregate, Optional (Array)
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail Aggregate, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { DUNSNumber string, up to 15 chars Pattern: {([0-9a-zA-Z]*)}, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { OrganizationPrimaryName Aggregate, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { OrganizationPrimaryName { OrganizationName string, up to 256 chars, Required
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } SubjectDetail } OrganizationPrimaryName /Aggregate
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { OrganizationIdentificationNumberDetail Aggregate, Optional

An entry loop which can repeat multiple times to allow recording of the identifiers issued by organizations to uniquely identify subjects. The issuing organization may be a Registration Authority, Government Department or Commercial Enterprise E.g. Chamber of Commerce numbers, VAT numbers, etc.

ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { OrganizationIdentificationNumberDetail @TypeText Attribute
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { OrganizationIdentificationNumberDetail @DNBCodeValue Attribute
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { OrganizationIdentificationNumberDetail @DNBCodeTableNumber Attribute
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { OrganizationIdentificationNumberDetail { OrganizationIdentificationNumber string, at least 1 char, up to 40 chars, Required

A number assigned by an external body or by D&B which either uniquely identifies or helps to identify an organization.

END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } SubjectDetail } OrganizationIdentificationNumberDetail /Aggregate
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { PrimaryAddress Aggregate, Optional

Records the primary or physical address of a subject/Case. For an organization this is the principal address at which the organization is located. For an individual, this is the home address.

ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { PrimaryAddress { StreetAddressLine Aggregate, Optional (Array)
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { PrimaryAddress { StreetAddressLine { LineText string, up to 240 chars, Required
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { PrimaryAddress { StreetAddressLine { DisplaySequence integer, up to 3 digits, Optional
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } SubjectDetail } PrimaryAddress } StreetAddressLine /Aggregate
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { PrimaryAddress { PrimaryTownName string, up to 64 chars, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { PrimaryAddress { CountryISOAlpha2Code string, at least 2 chars, up to 2 chars, Required
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { PrimaryAddress { TerritoryName string, up to 64 chars, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { PrimaryAddress { FullPostalCode string, up to 32 chars, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { PrimaryAddress { CountyName string, up to 64 chars, Optional
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } SubjectDetail } PrimaryAddress /Aggregate
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { TelephoneNumber Aggregate, Optional

An entry loop which can allow multiple Telephone contact information used for voice communication with the subject.

ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { TelephoneNumber { TelecommunicationNumber string, at least 1 char, up to 50 chars, Required

A sequence of digits used by the subject for voice communication in a public switched telephone network. This sequence of digits includes the area code or city code. Note: This number does not include the International Dialing Code and Domestic Dialing Code.

ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { TelephoneNumber { InternationalDialingCode string, up to 7 chars, Optional

The country calling code assigned by the International Telecommunication Union (ITU) required to connect to this Telecommunication Number of the subject country when dialing from outside the subject country; e.g., '1' for the US, '44' for the UK, '91' for India.

END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } SubjectDetail } TelephoneNumber /Aggregate
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { FamilyTreeMemberRole Aggregate, Optional (Array)
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { FamilyTreeMemberRole { FamilyTreeMemberRoleText string, up to 256 chars, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { FamilyTreeMemberRole { FamilyTreeMemberRoleText @DNBCodeValue Attribute
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { FamilyTreeMemberRole { FamilyTreeMemberRoleText @DNBCodeTableNumber Attribute

Possible values: 202 [Family Tree Member Role]

END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } SubjectDetail } FamilyTreeMemberRole /Aggregate
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { IndividualName Aggregate, Optional

Records the different names of the person by which he/she is known in mutiple languages and writing scripts.

ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { IndividualName { FirstName string, up to 64 chars, Optional

The given name of the individual. If this is not known then an initial may be supplied.

ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { IndividualName { LastName string, up to 64 chars, Optional

The portion of the individual's name usually presented at the end used to identify the members of a family.

ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { IndividualName { FullName FullName up to 256 chars, Optional

Records the details of the Full Name of the Individual on which the Consumer report is Pulled (this is applicable only when archiving consumer reports)

ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { IndividualName { FullName @FormatText Attribute
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } SubjectDetail } IndividualName /Aggregate
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { OperatingStatusText string, up to 256 chars, Optional

Text describing this organization/s functional state / trading status, e.g. active, out of business, dormant.

ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { OperatingStatusText @DNBCodeValue Attribute
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { SubjectDetail { OperatingStatusText @DNBCodeTableNumber Attribute
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } SubjectDetail /Aggregate
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { OrderTimestamp dateTime, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ApplicationTransactionID string, up to 64 chars, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product Aggregate, Optional (Array)
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { ArchiveDetail Aggregate, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { ArchiveDetail { ExtendArchivePeriodIndicator boolean, Required

When 'true' the duration to archive the data is to be extended. Note: There is an additional cost for extending the archival period of the data purchased. When 'false' the duration to archive the data is not to be extended.

ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { ArchiveDetail { PortfolioAssetID PortfolioAssetIDType, Optional
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } Product } ArchiveDetail /Aggregate
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { DNBProductID string, up to 64 chars, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { DNBProductName string, up to 256 chars, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { TradeUpIndicator boolean, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { BilledIndicator boolean, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { LanguageCode integer, up to 7 digits, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { InvestigationFulfillmentDetail Aggregate, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { InvestigationFulfillmentDetail { FulfillmentTimeStamp dateTime, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { InvestigationFulfillmentDetail { InvestigationFulfillmentTypeValue InvestigationFulfillmentTypeValueEnum, Optional
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } Product } InvestigationFulfillmentDetail /Aggregate
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { InvestigationDeliveryDetail Aggregate, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { InvestigationDeliveryDetail { EmailAddress Aggregate, Optional (Up to 5x)
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { InvestigationDeliveryDetail { EmailAddress { TelecommunicationAddress string, up to 240 chars, Required
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } Product } InvestigationDeliveryDetail } EmailAddress /Aggregate
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { InvestigationDeliveryDetail { DeliveryTimestamp dateTime, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { InvestigationDeliveryDetail { DeliveryMethodText string, up to 256 chars, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { InvestigationDeliveryDetail { DeliveryMethodText @DNBCodeValue Attribute
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { InvestigationDeliveryDetail { DeliveryMethodText @DNBCodeTableNumber Attribute

Possible values: 148 [Delivery Mechanism Type]

END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } Product } InvestigationDeliveryDetail /Aggregate
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { InvestigationNotificationDetail Aggregate, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { InvestigationNotificationDetail { EmailAddress Aggregate, Optional (Up to 5x)
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { InvestigationNotificationDetail { EmailAddress { TelecommunicationAddress string, up to 240 chars, Required
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } Product } InvestigationNotificationDetail } EmailAddress /Aggregate
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { InvestigationNotificationDetail { NotificationTimestamp dateTime, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { InvestigationNotificationDetail { NotificationMethodText string, up to 256 chars, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { InvestigationNotificationDetail { NotificationMethodText @DNBCodeValue Attribute
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { InvestigationNotificationDetail { NotificationMethodText @DNBCodeTableNumber Attribute
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } Product } InvestigationNotificationDetail /Aggregate
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { UserReadIndicator boolean, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { GroupAdminReadIndicator boolean, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { ObjectAttachment Aggregate, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { ObjectAttachment { ObjectFormatTypeText string, up to 256 chars, Required
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { ObjectAttachment { ObjectFormatTypeText @DNBCodeValue Attribute
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { Product { ObjectAttachment { ObjectFormatTypeText @DNBCodeTableNumber Attribute

Possible values: 126 [Object Format]

END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } Product } ObjectAttachment /Aggregate
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } Product /Aggregate
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail Aggregate, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { GlobalDecisionMakerDetail Aggregate, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { GlobalDecisionMakerDetail { CreditDecisionSpecification Aggregate, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { GlobalDecisionMakerDetail { CreditDecisionSpecification { RiskPolicyRuleName string, up to 64 chars, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { GlobalDecisionMakerDetail { CreditDecisionSpecification { RiskPolicyRuleVersionNumber string, up to 5 chars, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { GlobalDecisionMakerDetail { CreditDecisionSpecification { CreditAssessmentAmount AmountType, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { GlobalDecisionMakerDetail { CreditDecisionSpecification { CreditAssessmentAmount @CurrencyISOAlpha3Code Attribute
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { GlobalDecisionMakerDetail { CreditDecisionSpecification { CreditAssessmentAmount @UnitOfSize Attribute
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { GlobalDecisionMakerDetail { CreditDecisionSpecification { CreditAssessmentAmount @ReliabilityText Attribute
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { GlobalDecisionMakerDetail { CreditDecisionSpecification { OutstandingBalanceAmount AmountType, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { GlobalDecisionMakerDetail { CreditDecisionSpecification { OutstandingBalanceAmount @CurrencyISOAlpha3Code Attribute
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { GlobalDecisionMakerDetail { CreditDecisionSpecification { OutstandingBalanceAmount @UnitOfSize Attribute
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { GlobalDecisionMakerDetail { CreditDecisionSpecification { OutstandingBalanceAmount @ReliabilityText Attribute
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { GlobalDecisionMakerDetail { CreditDecisionSpecification { AdditionalDecisionParameter Aggregate, Optional (Array)
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { GlobalDecisionMakerDetail { CreditDecisionSpecification { AdditionalDecisionParameter { ParameterDescription string, up to 64 chars, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { GlobalDecisionMakerDetail { CreditDecisionSpecification { AdditionalDecisionParameter { ParameterValue string, up to 64 chars, Optional
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } ProductSpecificDetail } GlobalDecisionMakerDetail } CreditDecisionSpecification } AdditionalDecisionParameter /Aggregate
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } ProductSpecificDetail } GlobalDecisionMakerDetail } CreditDecisionSpecification /Aggregate
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { GlobalDecisionMakerDetail { CreditDecisionDetail Aggregate, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { GlobalDecisionMakerDetail { CreditDecisionDetail { DNBRecommendedCreditDecisionValue string, up to 16 chars, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { GlobalDecisionMakerDetail { CreditDecisionDetail { DNBRecommendedCreditLimitAmount AmountType, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { GlobalDecisionMakerDetail { CreditDecisionDetail { DNBRecommendedCreditLimitAmount @CurrencyISOAlpha3Code Attribute
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { GlobalDecisionMakerDetail { CreditDecisionDetail { DNBRecommendedCreditLimitAmount @UnitOfSize Attribute
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { GlobalDecisionMakerDetail { CreditDecisionDetail { DNBRecommendedCreditLimitAmount @ReliabilityText Attribute
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { GlobalDecisionMakerDetail { CreditDecisionDetail { RiskScore string, up to 16 chars, Optional
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } ProductSpecificDetail } GlobalDecisionMakerDetail } CreditDecisionDetail /Aggregate
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } ProductSpecificDetail } GlobalDecisionMakerDetail /Aggregate
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { DetailedTradeRiskInsightDetail Aggregate, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { DetailedTradeRiskInsightDetail { TradeDataMonthsFulfilledCount integer, Required
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { DetailedTradeRiskInsightDetail { HeadquartersTradeDataOnlyIndicator boolean, Required
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { DetailedTradeRiskInsightDetail { BranchTradeDataOnlyIndicator boolean, Required
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } ProductSpecificDetail } DetailedTradeRiskInsightDetail /Aggregate
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { AdditionalParameter Aggregate, Optional (Array)

An entry loop which can repeat multiple times to allow the recording of information on this subject which are not recorded in any of the discrete elements.

ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { AdditionalParameter { ParameterDescription string, up to 64 chars, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { ProductSpecificDetail { AdditionalParameter { ParameterValue string, up to 64 chars, Optional
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } ProductSpecificDetail } AdditionalParameter /Aggregate
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } ProductSpecificDetail /Aggregate
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { InvestigationDetail Aggregate, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { InvestigationDetail { InvestigationTrackingID InvestigationTrackingID at least 1 char up to 50 chars, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { InvestigationDetail { PlacementDetail Aggregate, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { InvestigationDetail { PlacementDetail { InvestigationRemarksText string, up to 3000 chars, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { InvestigationDetail { PlacementDetail { InvestigationPriorityText string, up to 256 chars, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { InvestigationDetail { PlacementDetail { InvestigationPriorityText @DNBCodeValue Attribute

Possible values: [6341] Express; [6342] Tempo Fax 3-5 hours; [6343] Telephone Service 48 hrs; [6344] Priority; [6345] 2 Working Days; [6346] Special Enquiry Service 2 working days; [6347] Routine; [12552] Regular 3 Days; [12553] Priority 1 Way - 2 Days; [12555] Priority 2 Way - 2 Days; [12556] PDQ 2 Way - 1 Day

ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { InvestigationDetail { PlacementDetail { InvestigationPriorityText @DNBCodeTableNumber Attribute

Possible values: 154 [Investigation Priority Code]

END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } InvestigationDetail } PlacementDetail /Aggregate
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { InvestigationDetail { RequestorDetail Aggregate, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { InvestigationDetail { RequestorDetail { RequestorName string, up to 64 chars, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { InvestigationDetail { RequestorDetail { Address Aggregate, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { InvestigationDetail { RequestorDetail { Address { StreetAddressLine Aggregate, Optional (Array)
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { InvestigationDetail { RequestorDetail { Address { StreetAddressLine { LineText string, up to 240 chars, Required
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { InvestigationDetail { RequestorDetail { Address { StreetAddressLine { DisplaySequence integer, up to 3 digits, Optional
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } InvestigationDetail } RequestorDetail } Address } StreetAddressLine /Aggregate
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { InvestigationDetail { RequestorDetail { Address { PrimaryTownName string, up to 64 chars, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { InvestigationDetail { RequestorDetail { Address { CountryISOAlpha2Code string, at least 2 chars, up to 2 chars, Required
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { InvestigationDetail { RequestorDetail { Address { TerritoryName string, up to 64 chars, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { InvestigationDetail { RequestorDetail { Address { FullPostalCode string, up to 32 chars, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { InvestigationDetail { RequestorDetail { Address { CountyName string, up to 64 chars, Optional
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } InvestigationDetail } RequestorDetail } Address /Aggregate
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } InvestigationDetail } RequestorDetail /Aggregate
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { InvestigationDetail { UnableToLocateIndicator boolean, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { InvestigationDetail { InvestigationStatusText string, up to 256 chars, OptionalPossible values are Pending, Fulfilled, Cancelled
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } InvestigationDetail /Aggregate
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { InquiryReferenceDetail Aggregate, Optional
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { InquiryReferenceDetail { CustomerReferenceText string, at least 1 char, up to 240 chars, Optional (Up to 5x)
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { InquiryReferenceDetail { CustomerBillingEndorsementText string, at least 1 char, up to 240 chars, Optional
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate } InquiryReferenceDetail /Aggregate
ListPortfolioAssetResponse { ListPortfolioAssetResponseDetail { ListCandidate { DisplaySequence integer, up to 3 digits, Optional
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail } ListCandidate /Aggregate
END: ListPortfolioAssetResponse } ListPortfolioAssetResponseDetail /Aggregate
END: ListPortfolioAssetResponse /Aggregate

Response Codes & Error Handling

Successful service requests will return a CM000 response code in the TransactionResult ResultID field. Otherwise, one of the D&B Direct standard response codes will be returned.

This operation may return the following response codes: CM001, CM004, PT001, and SC001-SC009.

Operation-specific supplemental response code explanations:

PT001No Portfolio asset not found for given portfolio asset identifier or investigation tracking ID or asset removed from archive.

D&B Direct 2.0 API requests are provided on a metered basis; and may require entitlement prior to use in the production environment. In addition, a concurrency limit (QPS) is monitored to ensure that it is not exceeded. An error code will be returned in the event that a transaction is throttled.

While this operation is provided on a metered basis, usage is tracked; however, no billing for successful calls is recorded.

Feature Notes

While the portfolio feature is utilized by other D&B services, only items created by D&B Direct can be managed using this service.

The portfolio feature is also utilized by the D&B Direct Investigation Service.

Customers are requested to use the List Portfolio Asset query parameter accordingly while fetching the Investigation records status. Refer to Investigations page for more information

What to do Next

After you successfully retrieve a list of the asset(s) currently available in the Portfolio, you can perform the following operations using the asset ID value(s).