QBS API 1.0.0 Data Dictionary
This document serves as a data dictionary for QBS API 1.0.0 formats.
It is written for both prospective and new system integrators, consultants and other technical professionals interested in integrating with QBS.
Definitions
The following terms are referred to in this document.
| Term | Definition |
| Client, Clients | Organizations requesting military search orders |
| Endpoint | Web service or HTTP receiver that is exposed by an organization to receive inbound data |
| QBO | Acronym for Quandis Business Objects. Generally refers to any module or component that has been created by Quandis. |
Field Legend
| Field | Description |
| Data Element | Name descriptor of field |
| Type | Enumerated. See Field Type |
| Size | Field length |
| Req | Enumerated. See Required Type |
| Notes | Description of field |
Field Types
| Type | Description |
| AN | Alpha Numeric |
| A | Alpha |
| N | Numeric |
| D | Date. All dates follow format YYYY-MM-DD |
| B | Boolean |
| U | URL |
| E | Enumerated. See corresponding enumeration |
| Node | Node |
| Attribute | Attribute |
Required Types
| Type | Description |
| Y | Always required |
| N | Always optional |
| CO | Conditionally optional |
| O | Optional |
Message Formats
Order Request
The order request format is used for order placement using the QBS API. All sub-options can be set in the client profile section under API Order 1.0.0 Preferences on the QBS website. This allows each API option to be defaulted to the profile setting if they are omitted from the API request.
| Data Elements | Type | Size | Req | Notes |
| BankruptcyRequest | Node | Y | Container for order request | |
| Options | Node | Y | Root node for order options | |
| NationalSearch | B | N | Perform search at national level | |
| RegionalSearch | E | N | Perform an extra search on the bankruptcy’s regional site
Enumerations: Always, Never, OpenCasesOnly, NewestFiled, OldestFiled |
|
| DocketSearch | E | N | Pull all docket data for bankruptcies
Enumerations: Always, Never, OpenCasesOnly, NewestFiled, OldestFiled |
|
| DocketSearchOpenedDateAge | E | N | Filters dockets based on filing date age in years
Enumerations: 1-10 (represents years) |
|
| DocketSearchClosedDateAge | E | N | Filters dockets based on closed date age in years
Enumerations: 1-10 (represents years) |
|
| BankruptcyThreshold | N | N | Only pull Regional and/or Docket data if there are this number of bankruptcies or fewer. Allowed Values: 1-10 | |
| ContactSearch | B | N | Toggle to perform a skiptrace search for any contacts that do not have valid SSN information | |
| ContactThreshold | N | N | Maximum number of SkipTrace contacts to search Pacer for when a Contact Search is performed. | |
| GroupDocuments | E | N | How to combine all of the related documents when we create certificates
Enumerations: Per-Bankruptcy, Per-Contact, Per-Order |
|
| IncludeScreenShot | B | N | Toggle to include a screen shot of the search criteria as the first page of the certificate | |
| IncludeAP | B | N | Include AP Cases In Regional And Docket searches | |
| USSSNMask | E | N | Characters to use to mask the first 5 digits of the SSN in the certificates. Default: None. See USSSN Mask. | |
| RedactCertificateInformation | E | N | Comma separated values used to control portions of data to be remove from the certificates. See RedactCertificateInformation. | |
| ProductType | AN | N | Product format. See Product Type | |
| ProductDelivery | AN | N | Product delivery method. See Product Delivery | |
| FileNameFormat | AN | N | File Format Used To Name Product Images | |
| RegionalStates | AN | N | Comma separated list of state abbreviations to search regionally | |
| UseLegacy | B | N | Use the PCL legacy site to perform the search | |
| RegionalRefresh | E | N | Perform extra Free Regional Refresh
Enumerations: Always, Never, OpenCasesOnly |
|
| FilingDateStart | D | N | Search where Filing Date on or after date provided | |
| FilingDateEnd | D | N | Search where Filing Date on or before date provided | |
| ClosedDateStart | D | N | Search where Closed Date on or after date provided | |
| ClosedDateEnd | D | N | Search where Closed Date on or before date provided | |
| DismissedDateStart | D | N | Search where Dismissed Date on or after date provided | |
| DismissedDateEnd | D | N | Search where Dismissed Date on or before date provided | |
| DischargedDateStart | D | N | Search where Discharged Date on or after date provided | |
| DischargedDateEnd | D | N | Search where Discharged Date on or before date provided | |
| ProductEndpoint | U | N | URL where product is desired to be returned | |
| UserDefined | Node | N | Parent node for user defined options | |
| Option | Node | Y | Parent node for user defined key value pair | |
| Name | AN | 50 | Y | User defined option name |
| Value | AN | 255 | Y | User defined option value |
| Contacts | Node | Y | Parent node for contacts being searched | |
| ContactItem | Node | Y | Root node for Contact | |
| ContactID | AN | 50 | N | Unique client identifier for contact |
| ContactType | E | 50 | CO | Enumerated. See Contact Type |
| FirstName | AN | 255 | CO | First name of contact |
| MiddleName | AN | 50 | CO | Middle name of contact |
| LastName | A | 255 | CO | LastName of contact |
| Company | A | 255 | CO | Corporation name |
| USSSN | N | 9 | O | Social Security Number / ITIN. SSN can be last 4 or full 9 digits or ITIN 2-7 |
| EIN | N | 9 | O | Employer Identification Number used for Corporation searches. Formats include full 9 digits or 2-7 |
| City | AN | 100 | CO | City of contact |
| State | E | 2 | CO | Enumerated: State of contact represented by two digit state code. |
| PostalCode | AN | 10 | CO | PostalCode of party |
| UserDefined | Node | N | Parent node for user defined options of contact | |
| Option | Node | Y | Parent node for user defined key value pair | |
| Name | AN | 50 | Y | User defined option name |
| Value | AN | 255 | Y | User defined option value |
Order Request Acknowledgement
| Data Elements | Type | Size | Req | Notes |
| ImportCollection | Node | Y | Parent container of acknowledgement | |
| ImportFileID | Attribute, N | N | Quandis unique order identifier | |
| Status | Attribute, E | Y | Order processing status. Enumerations: Error, Pre Validation, Validation Error | |
| Success | E | Y | Used to indicate order has been successfully received. Enumerated: True, False | |
| Exceptions | Node | N | Parent container for order processing exceptions. Exceptions are present during processing errors | |
| Exception | Node | Y | Parent container for individual order exceptions | |
| Type | AN | 255 | Y | Exception type |
| Severity | AN | E | Y | Exception severity. Enumerations: Error, Warning |
| Message | AN | T | Y | Exception message |
Pickup Response
| Data Elements | Type | Size | Req | Notes |
| Messages | Node | Y | Parent container | |
| AvailableCount | Attribute | Y | Count of available messages | |
| Exception | AN | 255 | CO | Optional tag rendering errors encountered. Tag is only rendered in the case of an error |
| Message | Node | CO | Rendered when a message is available | |
| ID | Attribute | Y | Unique identifier for message represented as a GUID | |
| Exception | AN | 255 | CO | Optional tag rendering errors encountered during messages construction. Tag is only rendered in the event of an error. |
| BankruptcyResponse | Node | Y | Parent container of product data. See Product Data definition |
Product Notification
The Product Notification is used in the product notification/pickup model.
| Data Elements | Type | Size | Req | Notes |
| Pickups | Node | Y | Parent container for Pickups | |
| Pickup | Node | Y | Parent node for individual pickup | |
| ReadyDate | Date | 10 | Y | Date resource available for pickup |
| ResourceUrn | AN | 255 | N | URN for resource. Urn can be accessed using HTTP GET |
Product Response
| Data Elements | Type | Size | Req | Notes |
| Exception | AN | O | Optional tag rendering errors encountered during messages construction. Tag is only rendered in the event of an error. | |
| BankruptcyResponse | Node | Y | Parent container of product data. See Product Data definition. |
Product Data
| Data Elements | Type | Size | Req | Notes |
| BankruptcyResponse | Node | Y | Parent container for Bankruptcy response | |
| ImportFileID | Attribute | Y | Quandis unique order identifier | |
| Original | Attribute | Y | Count of original subjects submitted for searching | |
| SkiptraceAliases | Attribute | Y | Count of aliases generated from skiptrace lookup | |
| SourceReferenceNumber | Attribute | Y | Client source reference number | |
| Contacts | Node | Y | List of subjects that were searched | |
| Contact | Node | Y | Root node of individual search result | |
| ContactID | AN | N | Unique identifier for contact provided by client | |
| Template | E | 50 | Y | Enumerated: See Enumerations: Contact Template |
| Prefix | A | 5 | O | Prefix name of alias |
| FirstName | A | 50 | CO | First name of alias |
| MiddleName | A | 50 | CO | Middle name of alias |
| LastName | A | 50 | CO | Last name of alias |
| Company | A | 255 | CO | Corporation Name |
| Suffix | A | 5 | O | Suffix value of contact |
| Age | N | 3 | O | Age of alias |
| Address | AN | 100 | O | Address of alias |
| City | AN | 100 | O | City of alias |
| State | E | 2 | O | Enumerated: State of alias represented by two digit state code. |
| PostalCode | AN | 10 | O | PostalCode of alias |
| USSSN4 | N | 4 | Y | Last 4 SSN/ITIN of alias |
| BirthDate | AN | 10 | O | Birth date of alias |
| ValidDate | AN | 10 | O | Date when alias was first reported at address |
| ValidEnd | AN | 10 | O | Date when alias was last reported at address |
| Bankruptcies | Node | Parent container for bankruptcy results | ||
| Bankruptcy | Node | Parent container for individual bankruptcy result | ||
| Bankruptcy | AN | 255 | Y | Name the bankruptcy was filed as |
| BKCaseNo | AN | 50 | Y | Bankruptcy Case Number |
| Chapter | AN | 2 | Y | Bankruptcy Chapter |
| StateOfFiling | AN | 2 | Y | State this bankruptcy was filed in |
| Court | AN | 255 | Y | Regional court Name |
| USSSN4 | N | 4 | Y | Last 4 of USSSN |
| Disposition | AN | 255 | O | Disposition text pulled from the National site, if it exists |
| ClosedReason | AN | 50 | O | Parsed closed reason from the National site |
| FilingDate | AN | 10 | O | Filed date from the National site, or regional site if it was searched. |
| DateClosed | AN | 10 | O | Closed date from the National site, or regional site if it was searched. |
| DischargedDate | AN | 10 | O | Discharged Date parsed from the regional site |
| DismissedDate | AN | 10 | O | Dismissed Date parsed from the regional site. |
| ConvertedDate | AN | 10 | O | Converted Date parsed from the regional site. |
| ReopendedDate | AN | 10 | O | Re-Opened date parsed from the regional site. |
| ConfirmationHearingDate | AN | 10 | O | Confirmation Hearing Date parsed from the regional site. |
| TransferredDate | AN | 10 | O | Transferred Date parsed from the regional site. |
| Status | E | 50 | Y | Enumerated: See Enumerations: Bankruptcy Status |
| Contacts | Node | Parent container for bankruptcy contacts parsed from the regional site | ||
| Contact | Node | Parent container for individual bankruptcy contact | ||
| ContactType | E | 50 | O | Enumerated: See Enumerations: Bankruptcy Contact Type |
| Contact | AN | 255 | Y | Contact name |
| City | AN | 50 | O | City for this contact |
| ContactMethods | Node | Parent container for contact methods associated with this contact | ||
| Method | Node | Container for individual contact method | ||
| Type | E | 50 | Y | Enumerated: See Enumerations: Bankruptcy Contact Method Types |
| ContactValue | AN | 255 | Y | Contact method value |
| Dockets | Node | Parent container for all docket records | ||
| Docket | Node | Parent container for individual docket record | ||
| Sequence | N | O | Sequence Number | |
| FilingDate | AN | 10 | O | Filing date |
| DocumentUrl | AN | O | Document URL | |
| Text | AN | Max | Y | Text description |
| CaseNumber | AN | 50 | Y | Bankruptcy BKCaseNo |
| Document | Node | Y | Root node for certificate | |
| Name | AN | 50 | Y | Image name. This name corresponds to the document entry in the Documents node. Documents match on the value indicated in the Name node. |
| Type | E | 50 | Y | Type of image. Enumerated: see Document |
| Messages | Node | Collection container for messages | ||
| Message | Node | Root node for message | ||
| Message | AN | 100 | Y | Message Subject |
| BodyText | AN | Max | Y | Message content |
| DateAdded | AN | 10 | Y | Date this message was created |
| Type | E | 50 | Y | Enumerated: Values: No Hit |
| DocumentCollection | Node | Y | Collection container for documents. This is the designated section for document content | |
| Document | Node | Y | Root node for image | |
| DocumentID | AN | 255 | Unique identifier for document | |
| Name | AN | 50 | Y | Image name |
| Type | E | 50 | Y | Type of image. Enumerated: see Document |
| Content | AN | Max | Y | Base64 encoded document content |
Enumerations
Product Type
| Enumeration | Description |
| API 1.0.0 | Standard API Format |
| Standard | Standard MS Excel Format |
| Custom | Custom product format |
Product Delivery
| Enumeration | Description |
| Deliver | Submit product data to endpoint |
| Pickup | Enable product for client pickup. No pickup notification will be sent and polling model must be utilized |
| NotificationPickup | Notification is transmitted to client endpoint containing product resource for pickup. Client must invoke product method and to download product |
| Custom | Custom delivery method. Utilized for specialized connectors |
Contact Type
| Enumeration | Description |
| Party | Party |
| Corporation | Indicates corporation used for corporiation search |
| 1 | Primary Borrower |
| 2 | Secondary Borrower |
| 3 | Tertiary Borrower |
| 4 | Borrower position 4 |
| 5 | Borrower position 5 |
| 6 | Borrower position 6 |
| 7 | Borrower position 7 |
| 8 | Borrower position 8 |
| 9 | Borrower position 9 |
| 9 | Borrower position 9 |
| 9 | Borrower position 9 |
Contact Template
| Enumeration | Description |
| Original | Contact submitted with order |
| Alias | Alias generated by order |
| Parsed Original | Indicates party value was parsed and normalized |
| Parsed Alias | Alias generated by parsing logic |
USSSN Mask
| Enumeration | Description |
| None | Do not mask the SSN of parties in PACER certificates |
| ***** | Mask first five digits of all parties in PACER certificates |
| Full | Fully mask all digits of all parties in PACER certificates |
RedactCertificateInformation
| Enumeration | Description |
| HideNationalUser | Removes the login name from the national certificate |
| HideNationalClient | Removes the client code from the national certificate |
| HideNationalCost |
Remove the cost from the national certificate |
| HideNationalReceipt |
Hides the entire receipt from the national certificate |
| HideSummaryUser |
Removes the login name from the regional/docket certificate |
| HideSummaryClient |
Removes the client code from the regional/docket certificate |
| HideSummaryCost |
Remove the cost from the regional/docket certificate |
| HideSummaryReceipt |
Hides the entire receipt from the regional/docket certificate |
| HideAllUsers |
Removes the login name from all certificates |
| HideAllClients |
Removes the client code from all certificates |
| HideAllCosts |
Remove the cost from all certificates |
| HideAllReceipts |
Hides the entire receipt from all certificates |
Bankruptcy Status
| Enumeration | Description |
| Active | Bankruptcy is currently active |
| Filed | Bankruptcy is currently active and has a filed date |
| Discharged | Bankruptcy is located and contains a discharge date |
| Dismissed | Bankruptcy is located and contains a dismissed date |
| No-Hit | No bankruptcies found for this contact |
| Standard Discharge | Bankruptcy may or may not be in a closed status. Refer to DateClosed node to determine its actual status. |
| Closed | Bankruptcy is in a closed status but was not dismissed or discharged. Refer to the disposition for the closed reason |
| Unknown | Bankruptcy is located but may have been re-opened: Status could not be determined |
Document
| Enumeration | Description |
| Bankruptcy Certificate | Bankruptcy certificate(s) which may contain additional pages depending on search options specified |
QBS Data Dictionary v1.0.0
Last Updated By: Quandis Data Services – Aug 2017