Skip to main content
WEBHOOK
govOrderedDocument
{
  "productKey": "<string>",
  "expectedDeliveryTime": "2023-11-07T05:31:56Z",
  "price": 1,
  "title": "<string>",
  "documentFormat": "<string>",
  "deliveredAt": "2023-11-07T05:31:56Z",
  "file": "<string>"
}

Headers

​
Idenfy-Event-Type
enum<string>
required
Available options:
GOV_ORDERED_DOCUMENT
​
Idenfy-Signature
string

Webhook signature

Body

application/json
​
productKey
string
required
​
expectedDeliveryTime
string<date-time>
required
​
price
number<double>
required
Required range: x >= 0
​
title
string | null
​
documentFormat
string
Maximum string length: 5
​
deliveredAt
string<date-time> | null
​
status
enum<string>
Available options:
NOT_ORDERED,
IN_PROGRESS,
FINISHED,
FAILED,
TIMED_OUT
​
file
string<uri> | null

Response

200

Return a 200 status to indicate that the data was received successfully.