v1
latestOpenAPI 3.1.02026-08-0642222.6 KBDocuments
List documents
List all the uploaded documents for a specific entity ID and type.
get/v2/documents
Query parameters
entityType'PNR' | 'COMPANY' | 'AIR_ITINERARY' | 'EVENT' | 'LOCATION_IMAGE' | 'AIR_COMMISSION_CONTRACT' required
Entity type against which the document is to uploaded.
Example:PNR
Entity type against which document is associated.
entityIdstring required
Entity Id for the given entity type.
Response
OK
Example response
{
"documents": [
{
"url": "https://s3.amazonaws.com/bucket-name/folder-name/file-name",
"documentId": "f49d00fe-1eda-4304-ba79-a980f565281d",
"documentMetadata": {
"documentType": "VISA",
"entityType": "PNR",
"entityId": "123124",
"entityMetadata": {
"pnrMetadata": {
"flightMetadata": {
"flightId": "CgNERU4SA1NGTxoKNTQ1NzI5ODcxMQ"
}
},
"invoiceMetadata": {
"invoiceNumber": "SPOT-0001",
"invoiceType": "FARE_INVOICE"
},
"travelType": "AIR"
},
"name": "BoardingPass.pdf"
}
}
]
}