NLDocSearch API (v1)

Register 1–100 documents for a case and receive one short-lived SAS URL per document for direct-to-blob upload. Documents are uploaded directly to Azure Blob Storage using the SAS URL — the API never proxies file bytes.

If a document with the same externalDocumentId is already registered under the same (companyId, productId), the existing record is returned with its current status. A new SAS URL is issued only for documents in registered status or earlier.

Call this endpoint after the blob PUT to sasUploadUrl succeeds. NLDS will verify the blob exists in landing storage and begin validation asynchronously. Response returns immediately with uploadStatus: upload_pending. Poll the document status endpoint to track validation progress.

Check whether documents identified by your system's externalDocumentId values are already registered in NLDS. Use this before batch registration to identify which documents to skip, retry, or re-upload.

Uniqueness is (companyId, productCode, externalDocumentId). Documents registered under different products are not returned.

Unknown externalDocumentId values are not included in the response — absence means not yet registered.

Call only after status endpoint returns complete or partial. Returns the full result set. isPartial: true when status is partial. Jobs expire 24 hours after creation — after expiry, results are no longer available.

Retrieve a short-lived access URL for a result document. Search results contain identifiers only — no direct storage URLs. Call this endpoint when presenting a result to a user who wants to open the document.

The access URL is generated at request time after re-checking tenant and document authorization. It expires in minutes (see expiresAt). Do not cache accessUrl beyond expiry — request a new one for each access.

Configure or update the webhook endpoint that NLDS calls when a query reaches a terminal state (complete, partial, or failed). There is one webhook configuration per company. Calling PUT again updates the existing configuration.

NLDS will send HTTP POST to your url with an NldsQueryResultEvent payload and an X-Webhook-Signature header (HMAC-SHA256 of the request body using your secret). Verify this signature before processing the event.

This endpoint is IMPLEMENTED BY THE CLIENT. NLDS will POST to the URL you configured via PUT /webhooks/query-result. This schema documents the expected payload structure and client responsibilities.

Your implementation must:

1. Verify the signature in X-Webhook-Signature header by computing HMAC-SHA256 of the raw request body using your configured secret.
2. Return HTTP 200 within 10 seconds.
3. Handle retries — the same eventId may be delivered multiple times; use it for deduplication on your side.
4. If not ready to handle the event, return a non-200 status or timeout; NLDS will retry.

NLDS retry policy:

• On non-200 response or timeout (>10 seconds): retry with exponential backoff
• Retry schedule: 1 minute, 5 minutes, 30 minutes
• Max 3 retries
• After exhausting retries, the event is dropped and an alert is raised on the NLDS side

Example verification code (Node.js):

const crypto = require('crypto');
const signature = req.headers['x-webhook-signature'];
const computed = crypto.createHmac('sha256', secret).update(rawBody).digest('hex');
if (signature !== computed) {
  return res.status(401).send('Signature invalid');
}