Page History

This page covers the second hop: how WIPO DAS reports a result to an OSF over the optional push-notification webhook.

When this applies

Only when both are true: - the OSF 's third-party configuration uses the API exchange protocol (EXCHANGE_PROTOCOL_API), and - the OSF is configured for API-based exchange and has registered a notificationUrl notification URL with DAS Support. If either condition is false, DAS never calls out to not, the OSF — the OSF must poll instead (— see 5.1.3.- Responses from DAS to OSF via GET).

if (protocol === EXCHANGE_PROTOCOL_API && notificationUrl) {
    postNotificationToOffice(notificationUrl, notification)
}

Payload shape

export type DocumentNotifications = {
  "systemId": string"WIPO_DAS",
  "notificationCategory": string"available",
  "dateTime": string"2026-10-19T10:00:00.000Z",
  "totalQuantity": number1,
  "documentRetrievalRequestStatusBag?": DocumentRetrievalRequestStatus[];
}

export type DocumentRetrievalRequestStatus = {
      "requestAckId": string | null,
"USIB20260101010101",
      "requestStatusCategory": string,
"success | errorCode?: stringpending | nullerror",
     //  "errorCode": "numeric EDI code, e.g. "-6"only present for errors",
  statusMessage?: string | null  // EDI message text, e.g. "ACCESS NOT AUTHORIZED"
};"statusMessage": "human-readable text"
    }
  ]
}

This is the only DAS→OSF channel that carries a numeric error code at all. It is not the same errorCode enum (INVALID_INPUT_DATA, OPERATION_FORBIDDEN, ...) used for synchronous REST validation errors — it's the legacy EDI numeric code, produced by re-translating the TDA/PDX code through getEDICodeByTDACode() / getEDIMessageByTDACode().

Example payloads

Success:

{
  "systemId": "WIPO_DAS",
  "notificationCategory": "available",
  "dateTime": "2026-10-19T10:00:00.000Z",
  "totalQuantity": 1,
  "documentRetrievalRequestStatusBag": [
    { "requestAckId": "USIB20260101010101", "requestStatusCategory": "success" }
  ]
}

Error — hosted OFF responded with TDA code 5 ("Not published, no authorization to permit access filed"):

{
  "systemId": "WIPO_DAS",
  "notificationCategory": "available",
  "dateTime": "2026-10-19T10:00:00.000Z",
  "totalQuantity": 1,
  "documentRetrievalRequestStatusBag": [
    {
      "requestAckId": "USIB20260101010101",
      "requestStatusCategory": "failure",
      "errorCode": "-6",
      "statusMessage": "ACCESS NOT AUTHORIZED"
    }
  ]
}

TDA/PDX code → what

...

you receive in the notification today (

...

office on legacy TDA/PDX)

🆕 What changes once this OFF migrates from TDA/PDX to REST

This EDI-translation step only happens for offices answering over the TDA/PDX protocol:

if ('tda' == event.respondingProtocol) {
    let ediErrorMsg = getEDIMessageByTDACode(parseInt(errorCode));
    ediCode        = getEDICodeByTDACode(parseInt(errorCode));
    data.documentRetrievalRequestStatusBag[0].errorCode = ediCode;
    data.documentRetrievalRequestStatusBag[0].statusMessage = ediErrorMsg;
} else {
    // REST / remote OFF: passed through AS-IS, no translation at all
    data.documentRetrievalRequestStatusBag[0].errorCode = errorCode;
    data.documentRetrievalRequestStatusBag[0].statusMessage = errorMessage;
}

Same table, once the office migrates to the new REST interface

Once an office answers over the newer REST interface instead of TDA/PDX (see Once an OFF implements the draft REST interface instead (5.1.1.- Responses from OFF to DAS (TDA/PDX codes)), DAS stops translating anything — the notification carries whatever errorCode/statusMessage the OFF that office's own REST endpoint sends is forwarded to the OSF verbatim.system sends — there is no fixed numeric code on this path, and errorCode is typically left empty.

Worked example — TDA code 5 ("Not published, no authorization to permit access filed"): - Today: errorCode: "-6", statusMessage: "ACCESS NOT AUTHORIZED" - After migration (per the 5.1.1 migration table): errorCode: null, statusMessage: "document awaiting security clearance" (the OFF's own choice — no guarantee it matches exactly this text until the vocabulary is formally closed)

Caveats (legacy TDA/PDX translation)

...