Method
POST /v1/verify/document-rules
Body Parameters
Headers
string
Bearer token (e.g.
Authorization: Bearer YOUR_API_KEY)string
application/jsonRequest Example
curl -X POST https://api.voyantcloud.com/v1/verify/document-rules \
-H "Authorization: Bearer $VOYANT_API_KEY" \
-H "content-type: application/json" \
-d '{
"marketId": "market_eu",
"productCountries": ["RO", "BG"]
}'
const res = await fetch("https://api.voyantcloud.com/v1/verify/document-rules", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.VOYANT_API_KEY}`,
"content-type": "application/json",
},
body: JSON.stringify({
marketId: "market_eu",
productId: "d0a6b9c0-5e4f-4f29-93c9-5f55bd6d2a20",
}),
})
const requirements = await res.json()
import os, requests
payload = {
"marketId": "market_us",
"productCountries": ["US"],
}
resp = requests.post(
"https://api.voyantcloud.com/v1/verify/document-rules",
headers={
"Authorization": f"Bearer {os.environ['VOYANT_API_KEY']}",
"content-type": "application/json",
},
json=payload,
)
rules = resp.json()
Response
{
"ok": true,
"requirements": [
{
"id": "6f9f1848-72d9-46f4-9e63-2f92f3736c55",
"appliesTo": { "travellerType": "adult" },
"documentType": { "code": "passport" },
"requireFields": ["number", "issueDate", "expiryDate"],
"label": "Passport",
"description": "Collect valid passport details for adult travellers"
},
{
"id": "9507f64a-1d0b-4013-9d5b-89794c3dcb30",
"appliesTo": { "travellerType": "child" },
"documentType": { "code": "birth_certificate" },
"requireFields": ["number"],
"label": null,
"description": null
}
]
}
{ "error": "Invalid request" }
Rules are filtered by effective date and country conditions. Send both market and itinerary details to ensure travellers see accurate document requirements during checkout.