Filing Office Lookup
Also known as Search by Filing Number
Product Code(s) | Not Applicable |
Option(s) | None |
Monitoring Available | No |
Interface | REST |
Method | GET |
Format(s) | JSON |
Service | Company |
{version} | 4.0 |
4.0 Released On | October 3, 2013 |
No modifications have been made to this data layer since the initial release.
Feature Request
IMPORTANT: Please see the new Online Services Security Enhancement Release, effective November 09, 2020.
Overview
When utilizing this D&B Direct feature, a filing number, encoded filing type, case-sensitive filing location state abbreviation and country code of "US" will be required.
This feature provides information for the following filing types: Suit, Lien, Judgment, UCC, Business Registration, and Bankruptcy.
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 product is entitled as "Search - Suits, Liens, Judgments & Bankruptcies" 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 NOT included in the D&B Direct Onboard suite.
Specification
Sample Request
GET https://direct.dnb.com/V4.0/organizations/publicrecords?TerritoryName=CA&searchbyfilingnumber=true&CountryISOAlpha2Code=US&FilingTypeCode=419&FilingNumber=60652958
Name
| Characteristics
|
---|
{version}
| Element |
ApplicationTransactionID
| string up to 64 chars., Optional
Unique Transaction ID of the request generated by the service |
TransactionTimestamp
| dateTime, Optional
The date and time when this request was created. When the request is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to the D&B function, i.e., the date and time when the xml document was created by the requesting intermediary. |
SubmittingOfficeID
| string up to 64 chars., Optional
A number that identifies the system or the software application from where this request originated. / A number used to uniquely identfy the D&B business segment or delivery channel from where this request originated. |
FilingTypeCode
| integer up to 7 digits., Required Possible values: 14824 (Business Registration); 419 (UCC); 8037 (suit); 8036 (Lein); 1625 (Judgement); 1626 (Bankruptcy) |
FilingNumber
| string up to 32 chars., Required |
TerritoryName
| string up to 64 chars., Required |
CountryISOAlpha2Code
| string at least 2 chars. up to 2 chars., Required |
CustomerReferenceText-n
| string at least 1 chars. up to 240 chars., Optional (Up to 5x)
A freeform reference string provided by the customer to be linked to the product in order to support subsequent order reconciliation. |
CustomerBillingEndorsementText
| string at least 1 chars. up to 240 chars., Optional
Text that is filled in by customer and commonly contains requesting individual or department name, or customer's own account/reference number and/or name for the case on which the product was provided.This text is a reference used during the billing process. |
Endpoint
Use the following endpoint for requesting this feature. The {version} is dependent on the underlying service delivering the response.
Endpoint (Company) |
---|
GET https://direct.dnb.com/V{version}/organizations/publicrecords?searchbyfilingnumber |
Testing
This operation will return a static set of results in the D&B Direct test environment (sandbox), regardless of the request parameters.
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
{"SearchByFilingNumberResponse": {
"TransactionDetail": {
"ServiceTransactionID": "Id-c2cadf5e519f56da05eb742e-1",
"TransactionTimestamp": "2013-05-24T08:02:36"
},
"TransactionResult": {
"SeverityText": "Information",
"ResultID": "CM000",
"ResultText": "Success"
},
"SearchByFilingNumberResponseDetail": {
"InquiryDetail": {
"FilingTypeCode": 419,
"FilingNumber": "60652958",
"FilingLocation": {
"TerritoryName": "DE",
"CountryISOAlpha2Code": "US"
}
},
"CandidateMatchedQuantity": 1,
"PublicFilingCandidate": [ {
"FilingNumber": "60652958",
"FilingOfficeDUNSNumber": "361538168",
"FilingOfficeName": "SECRETARY OF STATE/UCC DIVISION",
"FilingTerritoryName": "DE",
"PublicFilingSummary": {
"FilingTypeText": {
"@DNBCodeValue": 0,
"@DNBCodeTableNumber": 0,
"$": "UCC"
},
"TotalFilingsCount": 1
}
}],
"InquiryReferenceDetail": {"CustomerReferenceText": ["PRName"]}
}
}}
Name
| Characteristics
|
---|
SearchByFilingNumberResponse
| Aggregate |
SearchByFilingNumberResponse@ServiceVersionNumber
| Attribute |
SearchByFilingNumberResponse { TransactionDetail
| Aggregate, Required
Records information necessary to process a particular request. Examples of a request is the ordering of a product. |
SearchByFilingNumberResponse { TransactionDetail { ApplicationTransactionID
| string up to 64 chars., Optional
Unique Transaction ID of the request generated by the service |
SearchByFilingNumberResponse { TransactionDetail { ServiceTransactionID
| string up to 64 chars., Required
A number assigned by the D&B service to uniquely identify this transaction. |
SearchByFilingNumberResponse { TransactionDetail { TransactionTimestamp
| dateTime, Required
The date and time when this request was created. When the request is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to the D&B function, i.e., the date and time when the xml document was created by the requesting intermediary. |
END: SearchByFilingNumberResponse } TransactionDetail
| Aggregate |
SearchByFilingNumberResponse { TransactionResult
| Aggregate, Required
An aggregate that can repeat multiple times to record the different outcomes of the transaction. |
SearchByFilingNumberResponse { TransactionResult { SeverityText
| string, Required
Text that records the criticality of the outcome, e.g., Information, Warning, Error, Fatal. |
SearchByFilingNumberResponse { TransactionResult { ResultID
| string up to 32 chars., Required
An alphanumeric string that uniquely identifies the outcome of the transaction. |
SearchByFilingNumberResponse { TransactionResult { ResultText
| string up to 512 chars., Optional
Text that explains the outcome of the transaction. |
SearchByFilingNumberResponse { TransactionResult { ResultMessage
| Aggregate, Optional (Infinite)
An aggregate that can repeat multiple times to record textual data that expands on the ResultID and ResultText to provide additional information to the user regarding the status of the transaction. If the status implies that there is a problem this may also provide guidance to the user on how to address it. |
SearchByFilingNumberResponse { TransactionResult { ResultMessage { ResultDescription
| string up to 512 chars., Required
Text that describes the additional information regarding the outcome of the transaction. |
END: SearchByFilingNumberResponse } TransactionResult } ResultMessage
| Aggregate |
END: SearchByFilingNumberResponse } TransactionResult
| Aggregate |
SearchByFilingNumberResponse { SearchByFilingNumberResponseDetail
| Aggregate, Optional |
SearchByFilingNumberResponse { SearchByFilingNumberResponseDetail { InquiryDetail
| Aggregate, Required |
SearchByFilingNumberResponse { SearchByFilingNumberResponseDetail { InquiryDetail { FilingTypeCode
| integer up to 7 digits., Required |
SearchByFilingNumberResponse { SearchByFilingNumberResponseDetail { InquiryDetail { FilingNumber
| string up to 32 chars., Required |
SearchByFilingNumberResponse { SearchByFilingNumberResponseDetail { InquiryDetail { FilingLocation
| Aggregate, Required |
SearchByFilingNumberResponse { SearchByFilingNumberResponseDetail { InquiryDetail { FilingLocation { TerritoryName
| string up to 64 chars., Required |
SearchByFilingNumberResponse { SearchByFilingNumberResponseDetail { InquiryDetail { FilingLocation { CountryISOAlpha2Code
| string at least 2 chars. up to 2 chars., Required |
END: SearchByFilingNumberResponse } SearchByFilingNumberResponseDetail } InquiryDetail } FilingLocation
| Aggregate |
END: SearchByFilingNumberResponse } SearchByFilingNumberResponseDetail } InquiryDetail
| Aggregate |
SearchByFilingNumberResponse { SearchByFilingNumberResponseDetail { CandidateMatchedQuantity
| int up to 4 digits., Required |
SearchByFilingNumberResponse { SearchByFilingNumberResponseDetail { PublicFilingCandidate
| Aggregate, Required (Infinite) |
SearchByFilingNumberResponse { SearchByFilingNumberResponseDetail { PublicFilingCandidate { FilingNumber
| string up to 32 chars., Optional |
SearchByFilingNumberResponse { SearchByFilingNumberResponseDetail { PublicFilingCandidate { FilingOfficeDUNSNumber
| string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Optional |
SearchByFilingNumberResponse { SearchByFilingNumberResponseDetail { PublicFilingCandidate { FilingOfficeName
| string up to 256 chars., Required |
SearchByFilingNumberResponse { SearchByFilingNumberResponseDetail { PublicFilingCandidate { FilingTerritoryName
| string up to 64 chars., Optional |
SearchByFilingNumberResponse { SearchByFilingNumberResponseDetail { PublicFilingCandidate { PublicFilingSummary
| Aggregate, Optional |
SearchByFilingNumberResponse { SearchByFilingNumberResponseDetail { PublicFilingCandidate { PublicFilingSummary { FilingTypeText
| string up to 256 chars., Optional Possible values: 14824 (Business Registration); 419 (UCC); 8037 (suit); 8036 (Lein); 1625 (Judgement); 1626 (Bankruptcy) |
SearchByFilingNumberResponse { SearchByFilingNumberResponseDetail { PublicFilingCandidate { PublicFilingSummary { FilingTypeText@DNBCodeValue
| Attribute Possible values: 14824 (Business Registration); 419 (UCC); 8037 (suit); 8036 (Lein); 1625 (Judgement); 1626 (Bankruptcy) |
SearchByFilingNumberResponse { SearchByFilingNumberResponseDetail { PublicFilingCandidate { PublicFilingSummary { TotalFilingsCount
| int up to 7 digits., Optional |
END: SearchByFilingNumberResponse } SearchByFilingNumberResponseDetail } PublicFilingCandidate } PublicFilingSummary
| Aggregate |
END: SearchByFilingNumberResponse } SearchByFilingNumberResponseDetail } PublicFilingCandidate
| Aggregate |
SearchByFilingNumberResponse { SearchByFilingNumberResponseDetail { InquiryReferenceDetail
| Aggregate, Optional |
SearchByFilingNumberResponse { SearchByFilingNumberResponseDetail { InquiryReferenceDetail { CustomerReferenceText
| string at least 1 chars. up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to be linked to the product in order to support subsequent order reconciliation. |
END: SearchByFilingNumberResponse } SearchByFilingNumberResponseDetail } InquiryReferenceDetail
| Aggregate |
END: SearchByFilingNumberResponse } SearchByFilingNumberResponseDetail
| Aggregate |
END: SearchByFilingNumberResponse
| 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: CM002, CM004, CM005, CM007, CP001, CP002, and SC001-SC009.
Feature Notes
This feature returns the filing office name and D-U-N-S Number. Information about the parties involved in the filing is not returned.