Skip to main content
GET
/
api
/
v2
/
gov-ordered-documents
/
available-documents
Retrieve available documents to order
curl --request GET \
  --url https://api.example.com/api/v2/gov-ordered-documents/available-documents/ \
  --header 'Authorization: Basic <encoded-value>'
{
  "products": [
    {
      "id": "<string>",
      "price": 123,
      "productFormat": "<string>",
      "canOrder": true,
      "productCode": "<string>",
      "productTitle": "<string>",
      "deliveryTimeMinutes": 123,
      "type": "<string>",
      "displayDate": "<string>",
      "priceTag": "<string>",
      "companyName": "<string>",
      "countryISO": "<string>",
      "noVatPrice": "<string>",
      "vatCharge": "<string>",
      "currency": "<string>",
      "companyCode": "<string>",
      "productDetails": {},
      "downloadURL": "<string>",
      "propertyChanged": "<string>",
      "tierCode": "<string>",
      "tierValue": "<string>",
      "status": "NOT_ORDERED",
      "file": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The request must contain basic auth headers where username is API key and password is API secret.
In order for you to start using our API you will need an API key and API secret.
Both can be retrieved by contacting iDenfy's support or iDenfy's sales team.

Query Parameters

​
countryCode
enum<string>
required
Available options:
AL,
AM,
AR,
AT,
AU,
AW,
AZ,
BA,
BB,
BD,
BE,
BG,
BH,
BN,
BO,
BQ,
BR,
BW,
BY,
BZ,
CA,
CH,
CN,
CO,
CR,
CW,
CY,
CZ,
DE,
DK,
DO,
EC,
EE,
ES,
FI,
FR,
GB,
GE,
GG,
GH,
GI,
GR,
HK,
HR,
HU,
ID,
IE,
IL,
IM,
IN,
IS,
IT,
JE,
JO,
KH,
KW,
KY,
LI,
LK,
LS,
LT,
LU,
LV,
MA,
ME,
MH,
MM,
MT,
MU,
MY,
NL,
NO,
NZ,
PE,
PH,
PK,
PL,
PR,
PT,
QA,
RO,
RS,
RU,
SB,
SE,
SG,
SI,
SK,
TH,
TN,
TO,
TR,
TT,
TW,
UG,
US,
UY,
VG,
VI,
VN,
VU,
WS,
ZA
Minimum string length: 1
​
region
string
Minimum string length: 1
​
registrationNumber
string
required

External company ID from GOV registers search should be used.

Minimum string length: 1

Response

200 - application/json
​
products
object[]
required