Inquiries

List Inquiries

get

List inquiries with pagination and filtering, scoped to your organization.

Returns a paginated list of inquiries ordered by creation date. Use limit and offset query parameters to page through results. Supports text search and status/date filters.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT token from Cognito, or lender API key (vd__). API keys can be obtained via GET /users/me/api-key.

Query parameters

limitinteger · min: 1 · max: 500Optional

Number of results to return

Default: 100

offsetintegerOptional

Number of results to skip

Default: 0

searchany ofOptional

Search across business name, DBA, EIN, external ID

stringOptional

or

nullOptional

tagsany ofOptional

Comma-separated merchant tags (OR semantics)

stringOptional

or

nullOptional

statusany ofOptional

Comma-separated status filter (e.g. COMPLETED,RUNNING)

stringOptional

or

nullOptional

created_at_fromany ofOptional

Filter inquiries created after this time

string · date-timeOptional

or

nullOptional

created_at_toany ofOptional

Filter inquiries created before this time

string · date-timeOptional

or

nullOptional

sort_bystringOptional

Column to sort by (business_name, status, created_at, submitted_by)

Default: created_at

sort_orderstringOptional

Sort direction (asc or desc)

Default: desc

source_filtersany ofOptional

Comma-separated source filter predicates (e.g. SOS:ACTIVE,BBB:PRESENT)

stringOptional

or

nullOptional

scorecard_score_minany ofOptional

Filter to inquiries where any scorecard score is at or above this value

integerOptional

or

nullOptional

scorecard_score_maxany ofOptional

Filter to inquiries where any scorecard score is at or below this value

integerOptional

or

nullOptional

Responses

200

Successful Response

application/json

Paginated response for inquiry list endpoint

totalintegerRequired

limitintegerRequired

offsetintegerRequired

422

Validation Error

application/json

get

/v1/inquiries/

HTTPcURLJavaScriptPython

GET /v1/inquiries/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "total": 1,
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "PLANNING",
      "searchInput": {
        "business": {
          "name": "text",
          "dba": "text",
          "ein": "text",
          "addressLine1": "text",
          "addressLine2": "text",
          "city": "text",
          "state": "text",
          "zip": "text",
          "phone": "text",
          "email": "text",
          "domain": "text",
          "sosId": "text",
          "externalId": "text"
        },
        "principals": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "firstName": "text",
            "middleName": "text",
            "lastName": "text",
            "suffix": "text",
            "dob": "2026-03-25",
            "npi": "text",
            "phone": "text",
            "email": "text",
            "addr1": "text",
            "addr2": "text",
            "city": "text",
            "state": "text",
            "zip5": "text",
            "principalType": "UNKNOWN",
            "ownershipPercentage": 1,
            "searchNpi": false,
            "status": "PENDING",
            "createdAt": "2026-03-25T13:21:42.171Z"
          }
        ],
        "licenses": [
          {
            "licenseName": "text",
            "licenseId": "text",
            "licenseState": "text",
            "licenseCategory": "homeServices",
            "licenseSubcategory": "text",
            "source": "submitted"
          }
        ]
      },
      "externalId": "text",
      "submittedBy": "text",
      "createdAt": "2026-03-25T13:21:42.171Z",
      "startedAt": "2026-03-25T13:21:42.171Z",
      "completedAt": "2026-03-25T13:21:42.171Z",
      "progress": {
        "stage": "queued",
        "currentStep": 1,
        "totalSteps": 4
      },
      "processStatuses": [
        {
          "processType": "text",
          "status": "text",
          "producesSourceTypes": [
            "text"
          ],
          "isBackground": false,
          "processes": [
            {
              "status": "PENDING",
              "createdAt": "2026-03-25T13:21:42.171Z",
              "startedAt": "2026-03-25T13:21:42.171Z",
              "completedAt": "2026-03-25T13:21:42.171Z",
              "inputs": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              }
            }
          ],
          "errorMessage": "text",
          "retryable": false,
          "taskId": "text"
        }
      ],
      "links": {
        "pdf": "text"
      },
      "scorecardScore": 1,
      "businesses": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "nameDba": "text",
          "addr1": "text",
          "addr2": "text",
          "city": "text",
          "state": "text",
          "zip5": "text",
          "ein": "text",
          "phone": "text",
          "email": "text",
          "domainName": "text",
          "sourceRecords": [
            {
              "debtor": {
                "name": "Acme Corp"
              },
              "filingDate": "2025-06-01",
              "filingNumber": "12345",
              "meta": {
                "facts": [
                  {
                    "factType": "FILING_DATE",
                    "id": "a1b2c3d4-0000-0000-0000-000000000001",
                    "normalizedValue": "2025-06-01",
                    "value": "2025-06-01"
                  }
                ],
                "headline": "UCC Filing #12345",
                "id": "a1b2c3d4-0000-0000-0000-000000000010",
                "observedAt": "2026-01-15T12:00:00Z",
                "properties": [
                  {
                    "id": "a1b2c3d4-0000-0000-0000-000000000002",
                    "name": "jurisdiction",
                    "value": {
                      "state": "CA"
                    }
                  }
                ],
                "relations": {
                  "inboundRelations": [],
                  "outboundRelations": [],
                  "relatedSummary": {}
                },
                "sourceName": "LIEN",
                "sourceType": "filing",
                "subjectType": "business"
              }
            }
          ],
          "principals": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "firstName": "text",
              "middleName": "text",
              "lastName": "text",
              "suffix": "text",
              "dob": "2026-03-25",
              "phone": "text",
              "email": "text",
              "addr1": "text",
              "addr2": "text",
              "city": "text",
              "state": "text",
              "zip5": "text",
              "principalType": "UNKNOWN",
              "ownershipPercentage": 1,
              "associationConfidence": "IDENTIFYING",
              "sourceRecords": [
                {
                  "debtor": {
                    "name": "Acme Corp"
                  },
                  "filingDate": "2025-06-01",
                  "filingNumber": "12345",
                  "meta": {
                    "facts": [
                      {
                        "factType": "FILING_DATE",
                        "id": "a1b2c3d4-0000-0000-0000-000000000001",
                        "normalizedValue": "2025-06-01",
                        "value": "2025-06-01"
                      }
                    ],
                    "headline": "UCC Filing #12345",
                    "id": "a1b2c3d4-0000-0000-0000-000000000010",
                    "observedAt": "2026-01-15T12:00:00Z",
                    "properties": [
                      {
                        "id": "a1b2c3d4-0000-0000-0000-000000000002",
                        "name": "jurisdiction",
                        "value": {
                          "state": "CA"
                        }
                      }
                    ],
                    "relations": {
                      "inboundRelations": [],
                      "outboundRelations": [],
                      "relatedSummary": {}
                    },
                    "sourceName": "LIEN",
                    "sourceType": "filing",
                    "subjectType": "business"
                  }
                }
              ],
              "discoveryPrincipalId": "123e4567-e89b-12d3-a456-426614174000",
              "displayName": "text",
              "origin": "SUBMITTED",
              "submittedPrincipalIds": [
                "123e4567-e89b-12d3-a456-426614174000"
              ],
              "resolutionStatus": "PROCESSING",
              "createdAt": "2026-03-25T13:21:42.171Z"
            }
          ],
          "principalReports": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "displayName": "text",
              "firstName": "text",
              "middleName": "text",
              "lastName": "text",
              "suffix": "text",
              "dob": "2026-03-25",
              "phone": "text",
              "email": "text",
              "addr1": "text",
              "addr2": "text",
              "city": "text",
              "state": "text",
              "zip5": "text",
              "principalType": "UNKNOWN",
              "ownershipPercentage": 1,
              "associationConfidence": "IDENTIFYING",
              "kind": "SUBMITTED",
              "searchPrincipalId": "123e4567-e89b-12d3-a456-426614174000",
              "businessPrincipalId": "123e4567-e89b-12d3-a456-426614174000",
              "resolutionStatus": "PROCESSING",
              "steps": [
                {
                  "stepId": "text",
                  "label": "text",
                  "status": "pending",
                  "recordCount": 1,
                  "startedAt": "2026-03-25T13:21:42.171Z",
                  "completedAt": "2026-03-25T13:21:42.171Z"
                }
              ],
              "sourceRecords": [
                {
                  "debtor": {
                    "name": "Acme Corp"
                  },
                  "filingDate": "2025-06-01",
                  "filingNumber": "12345",
                  "meta": {
                    "facts": [
                      {
                        "factType": "FILING_DATE",
                        "id": "a1b2c3d4-0000-0000-0000-000000000001",
                        "normalizedValue": "2025-06-01",
                        "value": "2025-06-01"
                      }
                    ],
                    "headline": "UCC Filing #12345",
                    "id": "a1b2c3d4-0000-0000-0000-000000000010",
                    "observedAt": "2026-01-15T12:00:00Z",
                    "properties": [
                      {
                        "id": "a1b2c3d4-0000-0000-0000-000000000002",
                        "name": "jurisdiction",
                        "value": {
                          "state": "CA"
                        }
                      }
                    ],
                    "relations": {
                      "inboundRelations": [],
                      "outboundRelations": [],
                      "relatedSummary": {}
                    },
                    "sourceName": "LIEN",
                    "sourceType": "filing",
                    "subjectType": "business"
                  }
                }
              ],
              "evidenceCounts": {
                "liens": 0,
                "judgments": 0,
                "bankruptcies": 0,
                "ucc": 0,
                "courtDockets": 0,
                "criminal": 0,
                "other": 0,
                "hasPep": false
              }
            }
          ],
          "attributes": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "attributeCode": "text",
              "value": null,
              "description": "text",
              "calculatedAt": "2026-03-25T13:21:42.171Z"
            }
          ],
          "scores": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "modelCode": "text",
              "modelVersion": "text",
              "score": 1,
              "tier": "green",
              "contributions": [
                {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                }
              ],
              "calculatedAt": "2026-03-25T13:21:42.171Z"
            }
          ],
          "summary": {
            "summaryVersion": "v1",
            "searchTerms": {
              "businessName": "text",
              "businessDba": "text",
              "businessEin": "text",
              "businessAddress": "text",
              "businessCity": "text",
              "businessState": "text",
              "businessZip": "text",
              "businessPhone": "text",
              "businessEmail": "text",
              "businessDomain": "text",
              "businessSosId": "text",
              "principalNames": [
                "text"
              ]
            },
            "summary": {
              "overall": {
                "posture": "text",
                "confidence": 1,
                "reasons": [
                  "text"
                ]
              },
              "identity": {
                "status": "text",
                "matchedFields": [
                  "text"
                ],
                "conflicts": [
                  "text"
                ],
                "fieldMatches": [
                  {
                    "fieldKey": "text",
                    "label": "text",
                    "category": "text",
                    "inputValue": "text",
                    "matched": true,
                    "bestMatchValue": "text",
                    "similarity": 0,
                    "sourceCount": 0,
                    "sources": [
                      {
                        "sourceRecordId": "text",
                        "sourceName": "text",
                        "attributionRole": "text"
                      }
                    ]
                  }
                ]
              },
              "coverage": {
                "sourcesFound": [
                  "text"
                ],
                "sourceCounts": {
                  "ANY_ADDITIONAL_PROPERTY": 1
                },
                "sourceStatuses": [
                  {
                    "processType": "text",
                    "status": "text",
                    "recordCount": 0
                  }
                ]
              },
              "adverse": {
                "counts": {
                  "ANY_ADDITIONAL_PROPERTY": 1
                },
                "flags": [
                  "text"
                ]
              },
              "scoring": {
                "modelCode": "text",
                "tier": "text",
                "score": 1,
                "topContributions": [
                  {
                    "attributeCodes": [
                      "text"
                    ],
                    "points": 1,
                    "reason": "text",
                    "severity": "text"
                  }
                ],
                "relevanceSummary": {
                  "ANY_ADDITIONAL_PROPERTY": 1
                }
              },
              "quality": {
                "flags": [
                  "text"
                ],
                "completeness": 1
              }
            },
            "highlights": [
              {
                "id": "text",
                "severity": "text",
                "category": "top",
                "title": "text",
                "reasonCode": "text",
                "evidenceRefs": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                }
              }
            ],
            "workflow": {
              "stages": [
                {
                  "id": "text",
                  "status": "text"
                }
              ]
            }
          },
          "scorecard": {
            "code": "text",
            "name": "text",
            "items": [
              {
                "attributeCode": "text",
                "label": "text",
                "group": "text",
                "result": "text",
                "weight": 1,
                "value": null,
                "reason": "text",
                "description": "text"
              }
            ],
            "summary": {
              "passed": 1,
              "failed": 1,
              "skipped": 1,
              "total": 1,
              "score": 1
            }
          },
          "scorecards": [
            {
              "code": "text",
              "name": "text",
              "items": [
                {
                  "attributeCode": "text",
                  "label": "text",
                  "group": "text",
                  "result": "text",
                  "weight": 1,
                  "value": null,
                  "reason": "text",
                  "description": "text"
                }
              ],
              "summary": {
                "passed": 1,
                "failed": 1,
                "skipped": 1,
                "total": 1,
                "score": 1
              }
            }
          ],
          "tags": [
            "text"
          ],
          "createdAt": "2026-03-25T13:21:42.171Z"
        }
      ]
    }
  ],
  "limit": 1,
  "offset": 1
}

Create Inquiry

post

Create a new inquiry and start processing.

Submits business information for asynchronous verification and enrichment. The inquiry begins processing immediately and results are available via GET /v1/inquiries/{id}. Poll every 30 seconds until status reaches a terminal state.

Required fields:

• business_city and business_state

• At least one of business_name or business_dba

Optional fields that unlock additional verification:

• business_domain: Triggers domain verification. Commodity domains (gmail.com, yahoo.com, etc.) are automatically skipped.

• business_ein: Improves matching accuracy for Secretary of State and business verification.

• business_address_line1 + business_zip: Enables Secretary of State lookups and address verification.

• business_phone: Enables phone verification.

• business_email: Enables email verification.

• principals: Enables person-level searches. Each principal requires last_name. Adding dob enables additional background checks.

• licenses: Enables license verification when configured. Each entry needs license_name, license_id, license_state, and license_category.

Providing more fields produces richer, more accurate results.

Some verification sources are billable and must be enabled by Verdata for your organization before they will run. Examples include Public Reviews, Secretary of State Records, Address/Email/Phone Verification, Adverse Media, BLJs, Watchlists and Sanctions, Professional Licensing, and Domain Verification. Contact your Verdata representative to review available sources and enable them for your account.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT token from Cognito, or lender API key (vd__). API keys can be obtained via GET /users/me/api-key.

Body

application/json

Request model for creating an inquiry

businessNameany ofOptional

stringOptional

or

nullOptional

businessCitystringRequired

businessStatestringRequired

businessDbaany ofOptional

stringOptional

or

nullOptional

businessEinany ofOptional

stringOptional

or

nullOptional

businessAddressLine1any ofOptional

stringOptional

or

nullOptional

businessAddressLine2any ofOptional

stringOptional

or

nullOptional

businessZipany ofOptional

stringOptional

or

nullOptional

businessPhoneany ofOptional

stringOptional

or

nullOptional

businessEmailany ofOptional

stringOptional

or

nullOptional

businessDomainany ofOptional

stringOptional

or

nullOptional

businessSosIdany ofOptional

stringOptional

or

nullOptional

principalsany ofOptional

or

nullOptional

licensesany ofOptional

or

nullOptional

tagsany ofOptional

string[]Optional

or

nullOptional

externalIdany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Response model for inquiry

idstring · uuidRequired

statusstring · enumRequiredPossible values:

externalIdany ofOptional

stringOptional

or

nullOptional

submittedByany ofOptional

stringOptional

or

nullOptional

createdAtstring · date-timeRequired

startedAtany ofRequired

string · date-timeOptional

or

nullOptional

completedAtany ofRequired

string · date-timeOptional

or

nullOptional

progressany ofOptional

or

nullOptional

processStatusesany ofOptional

or

nullOptional

linksany ofOptional

or

nullOptional

scorecardScoreany ofOptional

integerOptional

or

nullOptional

businessesany ofOptional

or

nullOptional

422

Validation Error

application/json

post

/v1/inquiries/

HTTPcURLJavaScriptPython

POST /v1/inquiries/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 751

{
  "businessName": "text",
  "businessCity": "text",
  "businessState": "text",
  "businessDba": "text",
  "businessEin": "text",
  "businessAddressLine1": "text",
  "businessAddressLine2": "text",
  "businessZip": "text",
  "businessPhone": "text",
  "businessEmail": "text",
  "businessDomain": "text",
  "businessSosId": "text",
  "principals": [
    {
      "firstName": "text",
      "middleName": "text",
      "lastName": "text",
      "suffix": "text",
      "dob": "2026-03-25",
      "npi": "text",
      "phone": "text",
      "email": "text",
      "addr1": "text",
      "addr2": "text",
      "city": "text",
      "state": "text",
      "zip5": "text",
      "principalType": "UNKNOWN",
      "ownershipPercentage": 1,
      "searchNpi": false
    }
  ],
  "licenses": [
    {
      "licenseName": "text",
      "licenseId": "text",
      "licenseState": "text",
      "licenseCategory": "homeServices",
      "licenseSubcategory": "text"
    }
  ],
  "tags": [
    "text"
  ],
  "externalId": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "PLANNING",
  "searchInput": {
    "business": {
      "name": "text",
      "dba": "text",
      "ein": "text",
      "addressLine1": "text",
      "addressLine2": "text",
      "city": "text",
      "state": "text",
      "zip": "text",
      "phone": "text",
      "email": "text",
      "domain": "text",
      "sosId": "text",
      "externalId": "text"
    },
    "principals": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "firstName": "text",
        "middleName": "text",
        "lastName": "text",
        "suffix": "text",
        "dob": "2026-03-25",
        "npi": "text",
        "phone": "text",
        "email": "text",
        "addr1": "text",
        "addr2": "text",
        "city": "text",
        "state": "text",
        "zip5": "text",
        "principalType": "UNKNOWN",
        "ownershipPercentage": 1,
        "searchNpi": false,
        "status": "PENDING",
        "createdAt": "2026-03-25T13:21:42.171Z"
      }
    ],
    "licenses": [
      {
        "licenseName": "text",
        "licenseId": "text",
        "licenseState": "text",
        "licenseCategory": "homeServices",
        "licenseSubcategory": "text",
        "source": "submitted"
      }
    ]
  },
  "externalId": "text",
  "submittedBy": "text",
  "createdAt": "2026-03-25T13:21:42.171Z",
  "startedAt": "2026-03-25T13:21:42.171Z",
  "completedAt": "2026-03-25T13:21:42.171Z",
  "progress": {
    "stage": "queued",
    "currentStep": 1,
    "totalSteps": 4
  },
  "processStatuses": [
    {
      "processType": "text",
      "status": "text",
      "producesSourceTypes": [
        "text"
      ],
      "isBackground": false,
      "processes": [
        {
          "status": "PENDING",
          "createdAt": "2026-03-25T13:21:42.171Z",
          "startedAt": "2026-03-25T13:21:42.171Z",
          "completedAt": "2026-03-25T13:21:42.171Z",
          "inputs": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        }
      ],
      "errorMessage": "text",
      "retryable": false,
      "taskId": "text"
    }
  ],
  "links": {
    "pdf": "text"
  },
  "scorecardScore": 1,
  "businesses": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "nameDba": "text",
      "addr1": "text",
      "addr2": "text",
      "city": "text",
      "state": "text",
      "zip5": "text",
      "ein": "text",
      "phone": "text",
      "email": "text",
      "domainName": "text",
      "sourceRecords": [
        {
          "debtor": {
            "name": "Acme Corp"
          },
          "filingDate": "2025-06-01",
          "filingNumber": "12345",
          "meta": {
            "facts": [
              {
                "factType": "FILING_DATE",
                "id": "a1b2c3d4-0000-0000-0000-000000000001",
                "normalizedValue": "2025-06-01",
                "value": "2025-06-01"
              }
            ],
            "headline": "UCC Filing #12345",
            "id": "a1b2c3d4-0000-0000-0000-000000000010",
            "observedAt": "2026-01-15T12:00:00Z",
            "properties": [
              {
                "id": "a1b2c3d4-0000-0000-0000-000000000002",
                "name": "jurisdiction",
                "value": {
                  "state": "CA"
                }
              }
            ],
            "relations": {
              "inboundRelations": [],
              "outboundRelations": [],
              "relatedSummary": {}
            },
            "sourceName": "LIEN",
            "sourceType": "filing",
            "subjectType": "business"
          }
        }
      ],
      "principals": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "firstName": "text",
          "middleName": "text",
          "lastName": "text",
          "suffix": "text",
          "dob": "2026-03-25",
          "phone": "text",
          "email": "text",
          "addr1": "text",
          "addr2": "text",
          "city": "text",
          "state": "text",
          "zip5": "text",
          "principalType": "UNKNOWN",
          "ownershipPercentage": 1,
          "associationConfidence": "IDENTIFYING",
          "sourceRecords": [
            {
              "debtor": {
                "name": "Acme Corp"
              },
              "filingDate": "2025-06-01",
              "filingNumber": "12345",
              "meta": {
                "facts": [
                  {
                    "factType": "FILING_DATE",
                    "id": "a1b2c3d4-0000-0000-0000-000000000001",
                    "normalizedValue": "2025-06-01",
                    "value": "2025-06-01"
                  }
                ],
                "headline": "UCC Filing #12345",
                "id": "a1b2c3d4-0000-0000-0000-000000000010",
                "observedAt": "2026-01-15T12:00:00Z",
                "properties": [
                  {
                    "id": "a1b2c3d4-0000-0000-0000-000000000002",
                    "name": "jurisdiction",
                    "value": {
                      "state": "CA"
                    }
                  }
                ],
                "relations": {
                  "inboundRelations": [],
                  "outboundRelations": [],
                  "relatedSummary": {}
                },
                "sourceName": "LIEN",
                "sourceType": "filing",
                "subjectType": "business"
              }
            }
          ],
          "discoveryPrincipalId": "123e4567-e89b-12d3-a456-426614174000",
          "displayName": "text",
          "origin": "SUBMITTED",
          "submittedPrincipalIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "resolutionStatus": "PROCESSING",
          "createdAt": "2026-03-25T13:21:42.171Z"
        }
      ],
      "principalReports": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "displayName": "text",
          "firstName": "text",
          "middleName": "text",
          "lastName": "text",
          "suffix": "text",
          "dob": "2026-03-25",
          "phone": "text",
          "email": "text",
          "addr1": "text",
          "addr2": "text",
          "city": "text",
          "state": "text",
          "zip5": "text",
          "principalType": "UNKNOWN",
          "ownershipPercentage": 1,
          "associationConfidence": "IDENTIFYING",
          "kind": "SUBMITTED",
          "searchPrincipalId": "123e4567-e89b-12d3-a456-426614174000",
          "businessPrincipalId": "123e4567-e89b-12d3-a456-426614174000",
          "resolutionStatus": "PROCESSING",
          "steps": [
            {
              "stepId": "text",
              "label": "text",
              "status": "pending",
              "recordCount": 1,
              "startedAt": "2026-03-25T13:21:42.171Z",
              "completedAt": "2026-03-25T13:21:42.171Z"
            }
          ],
          "sourceRecords": [
            {
              "debtor": {
                "name": "Acme Corp"
              },
              "filingDate": "2025-06-01",
              "filingNumber": "12345",
              "meta": {
                "facts": [
                  {
                    "factType": "FILING_DATE",
                    "id": "a1b2c3d4-0000-0000-0000-000000000001",
                    "normalizedValue": "2025-06-01",
                    "value": "2025-06-01"
                  }
                ],
                "headline": "UCC Filing #12345",
                "id": "a1b2c3d4-0000-0000-0000-000000000010",
                "observedAt": "2026-01-15T12:00:00Z",
                "properties": [
                  {
                    "id": "a1b2c3d4-0000-0000-0000-000000000002",
                    "name": "jurisdiction",
                    "value": {
                      "state": "CA"
                    }
                  }
                ],
                "relations": {
                  "inboundRelations": [],
                  "outboundRelations": [],
                  "relatedSummary": {}
                },
                "sourceName": "LIEN",
                "sourceType": "filing",
                "subjectType": "business"
              }
            }
          ],
          "evidenceCounts": {
            "liens": 0,
            "judgments": 0,
            "bankruptcies": 0,
            "ucc": 0,
            "courtDockets": 0,
            "criminal": 0,
            "other": 0,
            "hasPep": false
          }
        }
      ],
      "attributes": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "attributeCode": "text",
          "value": null,
          "description": "text",
          "calculatedAt": "2026-03-25T13:21:42.171Z"
        }
      ],
      "scores": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "modelCode": "text",
          "modelVersion": "text",
          "score": 1,
          "tier": "green",
          "contributions": [
            {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          ],
          "calculatedAt": "2026-03-25T13:21:42.171Z"
        }
      ],
      "summary": {
        "summaryVersion": "v1",
        "searchTerms": {
          "businessName": "text",
          "businessDba": "text",
          "businessEin": "text",
          "businessAddress": "text",
          "businessCity": "text",
          "businessState": "text",
          "businessZip": "text",
          "businessPhone": "text",
          "businessEmail": "text",
          "businessDomain": "text",
          "businessSosId": "text",
          "principalNames": [
            "text"
          ]
        },
        "summary": {
          "overall": {
            "posture": "text",
            "confidence": 1,
            "reasons": [
              "text"
            ]
          },
          "identity": {
            "status": "text",
            "matchedFields": [
              "text"
            ],
            "conflicts": [
              "text"
            ],
            "fieldMatches": [
              {
                "fieldKey": "text",
                "label": "text",
                "category": "text",
                "inputValue": "text",
                "matched": true,
                "bestMatchValue": "text",
                "similarity": 0,
                "sourceCount": 0,
                "sources": [
                  {
                    "sourceRecordId": "text",
                    "sourceName": "text",
                    "attributionRole": "text"
                  }
                ]
              }
            ]
          },
          "coverage": {
            "sourcesFound": [
              "text"
            ],
            "sourceCounts": {
              "ANY_ADDITIONAL_PROPERTY": 1
            },
            "sourceStatuses": [
              {
                "processType": "text",
                "status": "text",
                "recordCount": 0
              }
            ]
          },
          "adverse": {
            "counts": {
              "ANY_ADDITIONAL_PROPERTY": 1
            },
            "flags": [
              "text"
            ]
          },
          "scoring": {
            "modelCode": "text",
            "tier": "text",
            "score": 1,
            "topContributions": [
              {
                "attributeCodes": [
                  "text"
                ],
                "points": 1,
                "reason": "text",
                "severity": "text"
              }
            ],
            "relevanceSummary": {
              "ANY_ADDITIONAL_PROPERTY": 1
            }
          },
          "quality": {
            "flags": [
              "text"
            ],
            "completeness": 1
          }
        },
        "highlights": [
          {
            "id": "text",
            "severity": "text",
            "category": "top",
            "title": "text",
            "reasonCode": "text",
            "evidenceRefs": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          }
        ],
        "workflow": {
          "stages": [
            {
              "id": "text",
              "status": "text"
            }
          ]
        }
      },
      "scorecard": {
        "code": "text",
        "name": "text",
        "items": [
          {
            "attributeCode": "text",
            "label": "text",
            "group": "text",
            "result": "text",
            "weight": 1,
            "value": null,
            "reason": "text",
            "description": "text"
          }
        ],
        "summary": {
          "passed": 1,
          "failed": 1,
          "skipped": 1,
          "total": 1,
          "score": 1
        }
      },
      "scorecards": [
        {
          "code": "text",
          "name": "text",
          "items": [
            {
              "attributeCode": "text",
              "label": "text",
              "group": "text",
              "result": "text",
              "weight": 1,
              "value": null,
              "reason": "text",
              "description": "text"
            }
          ],
          "summary": {
            "passed": 1,
            "failed": 1,
            "skipped": 1,
            "total": 1,
            "score": 1
          }
        }
      ],
      "tags": [
        "text"
      ],
      "createdAt": "2026-03-25T13:21:42.171Z"
    }
  ]
}

Get Inquiry

get

Get inquiry details including status, businesses, and source records.

Status lifecycle: PLANNING → RUNNING → ENRICHING → COMPLETED | PARTIAL_SUCCESS | FAILED

The progress field provides a simplified view of processing state with stage and current_step / total_steps. The businesses array is populated once processing completes and clustering finishes.

Poll this endpoint every 30 seconds until status is no longer PLANNING or RUNNING.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT token from Cognito, or lender API key (vd__). API keys can be obtained via GET /users/me/api-key.

Path parameters

inquiry_idstringRequired

Responses

200

Successful Response

application/json

Response model for inquiry

idstring · uuidRequired

statusstring · enumRequiredPossible values:

externalIdany ofOptional

stringOptional

or

nullOptional

submittedByany ofOptional

stringOptional

or

nullOptional

createdAtstring · date-timeRequired

startedAtany ofRequired

string · date-timeOptional

or

nullOptional

completedAtany ofRequired

string · date-timeOptional

or

nullOptional

progressany ofOptional

or

nullOptional

processStatusesany ofOptional

or

nullOptional

linksany ofOptional

or

nullOptional

scorecardScoreany ofOptional

integerOptional

or

nullOptional

businessesany ofOptional

or

nullOptional

422

Validation Error

application/json

get

/v1/inquiries/{inquiry_id}

HTTPcURLJavaScriptPython

GET /v1/inquiries/{inquiry_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "PLANNING",
  "searchInput": {
    "business": {
      "name": "text",
      "dba": "text",
      "ein": "text",
      "addressLine1": "text",
      "addressLine2": "text",
      "city": "text",
      "state": "text",
      "zip": "text",
      "phone": "text",
      "email": "text",
      "domain": "text",
      "sosId": "text",
      "externalId": "text"
    },
    "principals": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "firstName": "text",
        "middleName": "text",
        "lastName": "text",
        "suffix": "text",
        "dob": "2026-03-25",
        "npi": "text",
        "phone": "text",
        "email": "text",
        "addr1": "text",
        "addr2": "text",
        "city": "text",
        "state": "text",
        "zip5": "text",
        "principalType": "UNKNOWN",
        "ownershipPercentage": 1,
        "searchNpi": false,
        "status": "PENDING",
        "createdAt": "2026-03-25T13:21:42.171Z"
      }
    ],
    "licenses": [
      {
        "licenseName": "text",
        "licenseId": "text",
        "licenseState": "text",
        "licenseCategory": "homeServices",
        "licenseSubcategory": "text",
        "source": "submitted"
      }
    ]
  },
  "externalId": "text",
  "submittedBy": "text",
  "createdAt": "2026-03-25T13:21:42.171Z",
  "startedAt": "2026-03-25T13:21:42.171Z",
  "completedAt": "2026-03-25T13:21:42.171Z",
  "progress": {
    "stage": "queued",
    "currentStep": 1,
    "totalSteps": 4
  },
  "processStatuses": [
    {
      "processType": "text",
      "status": "text",
      "producesSourceTypes": [
        "text"
      ],
      "isBackground": false,
      "processes": [
        {
          "status": "PENDING",
          "createdAt": "2026-03-25T13:21:42.171Z",
          "startedAt": "2026-03-25T13:21:42.171Z",
          "completedAt": "2026-03-25T13:21:42.171Z",
          "inputs": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        }
      ],
      "errorMessage": "text",
      "retryable": false,
      "taskId": "text"
    }
  ],
  "links": {
    "pdf": "text"
  },
  "scorecardScore": 1,
  "businesses": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "nameDba": "text",
      "addr1": "text",
      "addr2": "text",
      "city": "text",
      "state": "text",
      "zip5": "text",
      "ein": "text",
      "phone": "text",
      "email": "text",
      "domainName": "text",
      "sourceRecords": [
        {
          "debtor": {
            "name": "Acme Corp"
          },
          "filingDate": "2025-06-01",
          "filingNumber": "12345",
          "meta": {
            "facts": [
              {
                "factType": "FILING_DATE",
                "id": "a1b2c3d4-0000-0000-0000-000000000001",
                "normalizedValue": "2025-06-01",
                "value": "2025-06-01"
              }
            ],
            "headline": "UCC Filing #12345",
            "id": "a1b2c3d4-0000-0000-0000-000000000010",
            "observedAt": "2026-01-15T12:00:00Z",
            "properties": [
              {
                "id": "a1b2c3d4-0000-0000-0000-000000000002",
                "name": "jurisdiction",
                "value": {
                  "state": "CA"
                }
              }
            ],
            "relations": {
              "inboundRelations": [],
              "outboundRelations": [],
              "relatedSummary": {}
            },
            "sourceName": "LIEN",
            "sourceType": "filing",
            "subjectType": "business"
          }
        }
      ],
      "principals": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "firstName": "text",
          "middleName": "text",
          "lastName": "text",
          "suffix": "text",
          "dob": "2026-03-25",
          "phone": "text",
          "email": "text",
          "addr1": "text",
          "addr2": "text",
          "city": "text",
          "state": "text",
          "zip5": "text",
          "principalType": "UNKNOWN",
          "ownershipPercentage": 1,
          "associationConfidence": "IDENTIFYING",
          "sourceRecords": [
            {
              "debtor": {
                "name": "Acme Corp"
              },
              "filingDate": "2025-06-01",
              "filingNumber": "12345",
              "meta": {
                "facts": [
                  {
                    "factType": "FILING_DATE",
                    "id": "a1b2c3d4-0000-0000-0000-000000000001",
                    "normalizedValue": "2025-06-01",
                    "value": "2025-06-01"
                  }
                ],
                "headline": "UCC Filing #12345",
                "id": "a1b2c3d4-0000-0000-0000-000000000010",
                "observedAt": "2026-01-15T12:00:00Z",
                "properties": [
                  {
                    "id": "a1b2c3d4-0000-0000-0000-000000000002",
                    "name": "jurisdiction",
                    "value": {
                      "state": "CA"
                    }
                  }
                ],
                "relations": {
                  "inboundRelations": [],
                  "outboundRelations": [],
                  "relatedSummary": {}
                },
                "sourceName": "LIEN",
                "sourceType": "filing",
                "subjectType": "business"
              }
            }
          ],
          "discoveryPrincipalId": "123e4567-e89b-12d3-a456-426614174000",
          "displayName": "text",
          "origin": "SUBMITTED",
          "submittedPrincipalIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "resolutionStatus": "PROCESSING",
          "createdAt": "2026-03-25T13:21:42.171Z"
        }
      ],
      "principalReports": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "displayName": "text",
          "firstName": "text",
          "middleName": "text",
          "lastName": "text",
          "suffix": "text",
          "dob": "2026-03-25",
          "phone": "text",
          "email": "text",
          "addr1": "text",
          "addr2": "text",
          "city": "text",
          "state": "text",
          "zip5": "text",
          "principalType": "UNKNOWN",
          "ownershipPercentage": 1,
          "associationConfidence": "IDENTIFYING",
          "kind": "SUBMITTED",
          "searchPrincipalId": "123e4567-e89b-12d3-a456-426614174000",
          "businessPrincipalId": "123e4567-e89b-12d3-a456-426614174000",
          "resolutionStatus": "PROCESSING",
          "steps": [
            {
              "stepId": "text",
              "label": "text",
              "status": "pending",
              "recordCount": 1,
              "startedAt": "2026-03-25T13:21:42.171Z",
              "completedAt": "2026-03-25T13:21:42.171Z"
            }
          ],
          "sourceRecords": [
            {
              "debtor": {
                "name": "Acme Corp"
              },
              "filingDate": "2025-06-01",
              "filingNumber": "12345",
              "meta": {
                "facts": [
                  {
                    "factType": "FILING_DATE",
                    "id": "a1b2c3d4-0000-0000-0000-000000000001",
                    "normalizedValue": "2025-06-01",
                    "value": "2025-06-01"
                  }
                ],
                "headline": "UCC Filing #12345",
                "id": "a1b2c3d4-0000-0000-0000-000000000010",
                "observedAt": "2026-01-15T12:00:00Z",
                "properties": [
                  {
                    "id": "a1b2c3d4-0000-0000-0000-000000000002",
                    "name": "jurisdiction",
                    "value": {
                      "state": "CA"
                    }
                  }
                ],
                "relations": {
                  "inboundRelations": [],
                  "outboundRelations": [],
                  "relatedSummary": {}
                },
                "sourceName": "LIEN",
                "sourceType": "filing",
                "subjectType": "business"
              }
            }
          ],
          "evidenceCounts": {
            "liens": 0,
            "judgments": 0,
            "bankruptcies": 0,
            "ucc": 0,
            "courtDockets": 0,
            "criminal": 0,
            "other": 0,
            "hasPep": false
          }
        }
      ],
      "attributes": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "attributeCode": "text",
          "value": null,
          "description": "text",
          "calculatedAt": "2026-03-25T13:21:42.171Z"
        }
      ],
      "scores": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "modelCode": "text",
          "modelVersion": "text",
          "score": 1,
          "tier": "green",
          "contributions": [
            {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          ],
          "calculatedAt": "2026-03-25T13:21:42.171Z"
        }
      ],
      "summary": {
        "summaryVersion": "v1",
        "searchTerms": {
          "businessName": "text",
          "businessDba": "text",
          "businessEin": "text",
          "businessAddress": "text",
          "businessCity": "text",
          "businessState": "text",
          "businessZip": "text",
          "businessPhone": "text",
          "businessEmail": "text",
          "businessDomain": "text",
          "businessSosId": "text",
          "principalNames": [
            "text"
          ]
        },
        "summary": {
          "overall": {
            "posture": "text",
            "confidence": 1,
            "reasons": [
              "text"
            ]
          },
          "identity": {
            "status": "text",
            "matchedFields": [
              "text"
            ],
            "conflicts": [
              "text"
            ],
            "fieldMatches": [
              {
                "fieldKey": "text",
                "label": "text",
                "category": "text",
                "inputValue": "text",
                "matched": true,
                "bestMatchValue": "text",
                "similarity": 0,
                "sourceCount": 0,
                "sources": [
                  {
                    "sourceRecordId": "text",
                    "sourceName": "text",
                    "attributionRole": "text"
                  }
                ]
              }
            ]
          },
          "coverage": {
            "sourcesFound": [
              "text"
            ],
            "sourceCounts": {
              "ANY_ADDITIONAL_PROPERTY": 1
            },
            "sourceStatuses": [
              {
                "processType": "text",
                "status": "text",
                "recordCount": 0
              }
            ]
          },
          "adverse": {
            "counts": {
              "ANY_ADDITIONAL_PROPERTY": 1
            },
            "flags": [
              "text"
            ]
          },
          "scoring": {
            "modelCode": "text",
            "tier": "text",
            "score": 1,
            "topContributions": [
              {
                "attributeCodes": [
                  "text"
                ],
                "points": 1,
                "reason": "text",
                "severity": "text"
              }
            ],
            "relevanceSummary": {
              "ANY_ADDITIONAL_PROPERTY": 1
            }
          },
          "quality": {
            "flags": [
              "text"
            ],
            "completeness": 1
          }
        },
        "highlights": [
          {
            "id": "text",
            "severity": "text",
            "category": "top",
            "title": "text",
            "reasonCode": "text",
            "evidenceRefs": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          }
        ],
        "workflow": {
          "stages": [
            {
              "id": "text",
              "status": "text"
            }
          ]
        }
      },
      "scorecard": {
        "code": "text",
        "name": "text",
        "items": [
          {
            "attributeCode": "text",
            "label": "text",
            "group": "text",
            "result": "text",
            "weight": 1,
            "value": null,
            "reason": "text",
            "description": "text"
          }
        ],
        "summary": {
          "passed": 1,
          "failed": 1,
          "skipped": 1,
          "total": 1,
          "score": 1
        }
      },
      "scorecards": [
        {
          "code": "text",
          "name": "text",
          "items": [
            {
              "attributeCode": "text",
              "label": "text",
              "group": "text",
              "result": "text",
              "weight": 1,
              "value": null,
              "reason": "text",
              "description": "text"
            }
          ],
          "summary": {
            "passed": 1,
            "failed": 1,
            "skipped": 1,
            "total": 1,
            "score": 1
          }
        }
      ],
      "tags": [
        "text"
      ],
      "createdAt": "2026-03-25T13:21:42.171Z"
    }
  ]
}

Add Principal

post

Add a principal to an existing inquiry.

Creates a new principal and triggers source processes for the new principal. If the inquiry has already completed, it will be reverted to RUNNING status and post-acquisition phases will re-run with the new data.

Request must include either a last_name or a business_principal_id.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT token from Cognito, or lender API key (vd__). API keys can be obtained via GET /users/me/api-key.

Path parameters

inquiry_idstringRequired

Body

application/json

Request model for adding a principal to an existing inquiry.

firstNameany ofOptional

stringOptional

or

nullOptional

middleNameany ofOptional

stringOptional

or

nullOptional

lastNameany ofOptional

stringOptional

or

nullOptional

suffixany ofOptional

stringOptional

or

nullOptional

dobany ofOptional

string · dateOptional

or

nullOptional

npiany ofOptional

stringOptional

or

nullOptional

phoneany ofOptional

stringOptional

or

nullOptional

emailany ofOptional

stringOptional

or

nullOptional

addr1any ofOptional

stringOptional

or

nullOptional

addr2any ofOptional

stringOptional

or

nullOptional

cityany ofOptional

stringOptional

or

nullOptional

stateany ofOptional

stringOptional

or

nullOptional

zip5any ofOptional

stringOptional

or

nullOptional

principalTypeany ofOptional

string · enumOptional

Role/title of a principal in a business.

Possible values:

or

nullOptional

ownershipPercentageany ofOptional

numberOptional

or

nullOptional

searchNpibooleanOptionalDefault: false

businessPrincipalIdany ofOptional

string · uuidOptional

or

nullOptional

Responses

200

Successful Response

application/json

Response model for adding a principal to an existing inquiry.

idstring · uuidRequired

firstNameany ofOptional

stringOptional

or

nullOptional

middleNameany ofOptional

stringOptional

or

nullOptional

lastNameany ofOptional

stringOptional

or

nullOptional

suffixany ofOptional

stringOptional

or

nullOptional

dobany ofOptional

string · dateOptional

or

nullOptional

npiany ofOptional

stringOptional

or

nullOptional

phoneany ofOptional

stringOptional

or

nullOptional

emailany ofOptional

stringOptional

or

nullOptional

addr1any ofOptional

stringOptional

or

nullOptional

addr2any ofOptional

stringOptional

or

nullOptional

cityany ofOptional

stringOptional

or

nullOptional

stateany ofOptional

stringOptional

or

nullOptional

zip5any ofOptional

stringOptional

or

nullOptional

principalTypeany ofOptional

string · enumOptional

Role/title of a principal in a business.

Possible values:

or

nullOptional

ownershipPercentageany ofOptional

numberOptional

or

nullOptional

searchNpibooleanOptionalDefault: false

statusstring · enumRequired

Status for a submitted principal during inquiry processing.

Possible values:

createdAtstring · date-timeRequired

422

Validation Error

application/json

post

/v1/inquiries/{inquiry_id}/principals

HTTPcURLJavaScriptPython

POST /v1/inquiries/{inquiry_id}/principals HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 338

{
  "firstName": "text",
  "middleName": "text",
  "lastName": "text",
  "suffix": "text",
  "dob": "2026-03-25",
  "npi": "text",
  "phone": "text",
  "email": "text",
  "addr1": "text",
  "addr2": "text",
  "city": "text",
  "state": "text",
  "zip5": "text",
  "principalType": "UNKNOWN",
  "ownershipPercentage": 1,
  "searchNpi": false,
  "businessPrincipalId": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "firstName": "text",
  "middleName": "text",
  "lastName": "text",
  "suffix": "text",
  "dob": "2026-03-25",
  "npi": "text",
  "phone": "text",
  "email": "text",
  "addr1": "text",
  "addr2": "text",
  "city": "text",
  "state": "text",
  "zip5": "text",
  "principalType": "UNKNOWN",
  "ownershipPercentage": 1,
  "searchNpi": false,
  "status": "PENDING",
  "createdAt": "2026-03-25T13:21:42.171Z"
}

Add License

post

Add a license for verification on an existing inquiry.

Appends to discovery.licenses with source='reported' and triggers a LICENSE_VERIFICATION process. Idempotent — deduped by (license_id, license_state, license_category). If the inquiry has already completed, it reverts to RUNNING status.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT token from Cognito, or lender API key (vd__). API keys can be obtained via GET /users/me/api-key.

Path parameters

inquiry_idstringRequired

Body

application/json

licenseNamestringRequired

licenseIdstringRequired

licenseStatestringRequired

licenseCategorystring · enumRequiredPossible values:

licenseSubcategoryany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

licenseNamestringRequired

licenseIdstringRequired

licenseStatestringRequired

licenseCategorystring · enumRequiredPossible values:

licenseSubcategoryany ofOptional

stringOptional

or

nullOptional

sourcestring · enumRequiredPossible values:

422

Validation Error

application/json

post

/v1/inquiries/{inquiry_id}/licenses

HTTPcURLJavaScriptPython

POST /v1/inquiries/{inquiry_id}/licenses HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "licenseName": "text",
  "licenseId": "text",
  "licenseState": "text",
  "licenseCategory": "homeServices",
  "licenseSubcategory": "text"
}

{
  "licenseName": "text",
  "licenseId": "text",
  "licenseState": "text",
  "licenseCategory": "homeServices",
  "licenseSubcategory": "text",
  "source": "submitted"
}

Add Filing

post

Add an SOS filing to an existing inquiry by looking up a Cobalt SOS ID.

Creates a COBALT_SOS process and enqueues it to the worker. The pipeline handles the Cobalt API call, fact extraction, and merchant linking.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT token from Cognito, or lender API key (vd__). API keys can be obtained via GET /users/me/api-key.

Path parameters

inquiry_idstringRequired

Body

application/json

Request model for adding an SOS filing to an existing inquiry.

sosIdstringRequired

sosStatestringRequired

Responses

200

Successful Response

application/json

Response model for inquiry process.

idstring · uuidRequired

taskIdstringRequired

attemptNumberintegerRequired

processTypestringRequired

statusstring · enumRequiredPossible values:

phasestring · enumRequired

Phase of discovery processing for dependency tracking.

Possible values:

isBackgroundbooleanOptionalDefault: false

parentTaskIdany ofOptional

stringOptional

or

nullOptional

createdAtstring · date-timeRequired

startedAtany ofOptional

string · date-timeOptional

or

nullOptional

completedAtany ofOptional

string · date-timeOptional

or

nullOptional

externalIdany ofOptional

string · uuidOptional

or

nullOptional

submissionResponseany ofOptional

or

nullOptional

422

Validation Error

application/json

post

/v1/inquiries/{inquiry_id}/filings

HTTPcURLJavaScriptPython

POST /v1/inquiries/{inquiry_id}/filings HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "sosId": "text",
  "sosState": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "taskId": "text",
  "attemptNumber": 1,
  "processType": "text",
  "status": "PENDING",
  "phase": "SOURCE",
  "isBackground": false,
  "parentTaskId": "text",
  "createdAt": "2026-03-25T13:21:42.171Z",
  "startedAt": "2026-03-25T13:21:42.171Z",
  "completedAt": "2026-03-25T13:21:42.171Z",
  "externalId": "123e4567-e89b-12d3-a456-426614174000",
  "submissionResponse": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Get Inquiry Pdf

get

Generate PDF report for an inquiry

Authorizations

BearerAuth

AuthorizationstringRequired

JWT token from Cognito, or lender API key (vd__). API keys can be obtained via GET /users/me/api-key.

Path parameters

inquiry_idstringRequired

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

get

/v1/inquiries/{inquiry_id}/pdf

HTTPcURLJavaScriptPython

GET /v1/inquiries/{inquiry_id}/pdf HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Retry Process

post

Retry a failed process.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT token from Cognito, or lender API key (vd__). API keys can be obtained via GET /users/me/api-key.

Path parameters

inquiry_idstringRequired

task_idstringRequired

Responses

200

Successful Response

application/json

Response model for inquiry process.

idstring · uuidRequired

taskIdstringRequired

attemptNumberintegerRequired

processTypestringRequired

statusstring · enumRequiredPossible values:

phasestring · enumRequired

Phase of discovery processing for dependency tracking.

Possible values:

isBackgroundbooleanOptionalDefault: false

parentTaskIdany ofOptional

stringOptional

or

nullOptional

createdAtstring · date-timeRequired

startedAtany ofOptional

string · date-timeOptional

or

nullOptional

completedAtany ofOptional

string · date-timeOptional

or

nullOptional

externalIdany ofOptional

string · uuidOptional

or

nullOptional

submissionResponseany ofOptional

or

nullOptional

422

Validation Error

application/json

post

/v1/inquiries/{inquiry_id}/processes/{task_id}/retry

HTTPcURLJavaScriptPython

POST /v1/inquiries/{inquiry_id}/processes/{task_id}/retry HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "taskId": "text",
  "attemptNumber": 1,
  "processType": "text",
  "status": "PENDING",
  "phase": "SOURCE",
  "isBackground": false,
  "parentTaskId": "text",
  "createdAt": "2026-03-25T13:21:42.171Z",
  "startedAt": "2026-03-25T13:21:42.171Z",
  "completedAt": "2026-03-25T13:21:42.171Z",
  "externalId": "123e4567-e89b-12d3-a456-426614174000",
  "submissionResponse": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Retry Failed Processes

post

Retry all failed source-phase processes with retryable errors.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT token from Cognito, or lender API key (vd__). API keys can be obtained via GET /users/me/api-key.

Path parameters

inquiry_idstringRequired

Responses

200

Successful Response

application/json

Response model for inquiry process.

idstring · uuidRequired

taskIdstringRequired

attemptNumberintegerRequired

processTypestringRequired

statusstring · enumRequiredPossible values:

phasestring · enumRequired

Phase of discovery processing for dependency tracking.

Possible values:

isBackgroundbooleanOptionalDefault: false

parentTaskIdany ofOptional

stringOptional

or

nullOptional

createdAtstring · date-timeRequired

startedAtany ofOptional

string · date-timeOptional

or

nullOptional

completedAtany ofOptional

string · date-timeOptional

or

nullOptional

externalIdany ofOptional

string · uuidOptional

or

nullOptional

submissionResponseany ofOptional

or

nullOptional

422

Validation Error

application/json

post

/v1/inquiries/{inquiry_id}/retry-failed

HTTPcURLJavaScriptPython

POST /v1/inquiries/{inquiry_id}/retry-failed HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "taskId": "text",
    "attemptNumber": 1,
    "processType": "text",
    "status": "PENDING",
    "phase": "SOURCE",
    "isBackground": false,
    "parentTaskId": "text",
    "createdAt": "2026-03-25T13:21:42.171Z",
    "startedAt": "2026-03-25T13:21:42.171Z",
    "completedAt": "2026-03-25T13:21:42.171Z",
    "externalId": "123e4567-e89b-12d3-a456-426614174000",
    "submissionResponse": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
]