SPspotnana
Documents

Upload a document

Changed on

Upload a document for a specific entity type (e.g., a PNR).

post/v2/documents

Request

  • Base URL
    https://api-ext-sboxmeta.partners.spotnana.com
  • Auth
    HTTP bearer

Request body multipart/form-data

filestring binary required

Contents of the document to be uploaded (PDF only). Accepts application/pdf or application/octet-stream.

documentMetadataStrstring

JSON string of DocumentMetadata - accepts application/octet-stream. Either documentMetadata or documentMetadataStr must be present.

Example request

{
  "documentMetadata": {
    "documentType": "VISA",
    "entityType": "PNR",
    "entityId": "123124",
    "entityMetadata": {
      "pnrMetadata": {
        "flightMetadata": {
          "flightId": "CgNERU4SA1NGTxoKNTQ1NzI5ODcxMQ"
        }
      },
      "invoiceMetadata": {
        "invoiceNumber": "SPOT-0001",
        "invoiceType": "FARE_INVOICE"
      },
      "travelType": "AIR"
    },
    "name": "BoardingPass.pdf"
  }
}

Response

OK

documentIdstring uuid required

Unique identifier of the document.

Example response

{
  "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"
  }
}

Changes

  • f7da04cc6fa2Revision changes
    • warning

      added the new AI_PLATFORM_ATTACHMENTS enum value to the / response property for the response status

    • info

      added the new AI_PLATFORM_ATTACHMENTS enum value to the request property /

  • 9643b71ec928Revision changes
    • warning

      added the new AI_SKILL_FILE enum value to the / response property for the response status

    • info

      added the new AI_SKILL_FILE enum value to the request property /