You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Current »

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

When this applies

Only when the OSF is configured for API-based exchange and has registered a notification URL with DAS Support. If not, the OSF must poll instead — see 5.1.3.- Responses from DAS to OSF via GET.

Payload shape

{
  "systemId": "WIPO_DAS",
  "notificationCategory": "available",
  "dateTime": "2026-10-19T10:00:00.000Z",
  "totalQuantity": 1,
  "documentRetrievalRequestStatusBag": [
    {
      "requestAckId": "USIB20260101010101",
      "requestStatusCategory": "success | pending | error",
      "errorCode": "numeric code, only present for errors",
      "statusMessage": "human-readable text"
    }
  ]
}

This is the only DAS→OSF channel that carries a numeric error code at all.

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)

TDA codeTDA/PDX meaningerrorCodestatusMessage
0 / 14 / 15Successful / Registered / Updated0Operation Successful
1Application number not found (or withdrawn/missing-field)-7APPLICATION NUMBER NOT FOUND
2File is not available (security)-8FILE WAS NOT AVAILABLE (REQUESTED APPLICATION EXISTS BUT IS NOT CLEARED FOR DISSEMINATION, e.g. security)
3Document(s) not found-9DOCUMENT(S) WAS NOT AVAILABLE (COMPLETE SET OF REQUIRED DOCUMENTS FOR CERTIFIED COPY IS NOT AVAILABLE)
5Not published / no authorization-6ACCESS NOT AUTHORIZED
7Oversize document, CD will be mailed(none)(none)
11ACC invalid-4INVALID DATA
12Request under processing(none)(none)
16ACC and priority date mismatch-15MISMATCH ACCESS CODE AND PRIORITY FILING DATE
17Priority date mismatch-12MISMATCH PRIORITY FILING DATE OR ACCESS CODE
18ACC mismatch (or missing)-14MISMATCH ACCESS CODE
19Priority date not provided-13MISSING PRIORITY FILING DATE
-1System scheduled downtime(none)(none)
-2System unavailable (back-end)(none)(none)
-6Duplicate doc / already registered (registration only)-1DUPLICATE (ENTRY ALREADY EXISTS)

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 5.1.1.- Responses from OFF to DAS (TDA/PDX codes)), the notification carries whatever errorCode/statusMessage that office's own system sends — there is no fixed numeric code on this path, and errorCode is typically left empty.

TDA/PDX code (for reference)errorCode after migrationstatusMessage after migration
0 / 14 / 15(empty)ready for download → delivered
1(empty)document number not available
2(empty)document awaiting security clearance
3(empty)document incomplete
5(empty)document awaiting security clearance
7(empty)(not applicable)
11(empty)unmatched access code
12(empty)awaiting off response
16(empty)unmatched document date and access code
17(empty)unmatched document date
18(empty)unmatched access code
19(empty)invalid document details
-1 / -2(reported as a system error instead)(reported as a system error instead)

Worked example — TDA code 5 ("Not published, no authorization to permit access filed"): - Today: errorCode: "-6", statusMessage: "ACCESS NOT AUTHORIZED" - After migration: errorCode: null, statusMessage: "document awaiting security clearance"

  • No labels