Skip to main content

SuccessResultDocumentErrorResultDocumentBatchResultSuccessResultResponse

correlationIdstring<uuid>

A unique ID of the request

Example: fb0ccbbc-62bc-447f-a47e-02b490e25690
isSuccessboolean

Indication of whether the request was successfull

result object
succeeded object[]
  • Array [
  • idstring<uuid>

    The unique identifier of the created resource.

    linkstringnullable

    The URL link to access the created resource.

    inputIndexinteger<int32>
    statusCodeinteger<int32>
    externalInvoiceIdstringnullable
    documentExtractionInfo object

    Information about the document extraction request. This is only set if Kaunt Document AI is used as the document extraction service.

    documentIdstringrequired

    The Document AI Document ID for the sent document

    extractionUrlstringrequired

    The URL to check the status of the document extraction request

  • ]
  • failed object[]
  • Array [
  • errorstringnullable
    inputIndexinteger<int32>
    statusCodeinteger<int32>
    externalInvoiceIdstringnullable
  • ]
  • SuccessResultDocumentErrorResultDocumentBatchResultSuccessResultResponse
    {
    "correlationId": "fb0ccbbc-62bc-447f-a47e-02b490e25690",
    "isSuccess": true,
    "result": {
    "succeeded": [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "link": "string",
    "inputIndex": 0,
    "statusCode": 0,
    "externalInvoiceId": "string",
    "documentExtractionInfo": {
    "documentId": "string",
    "extractionUrl": "string"
    }
    }
    ],
    "failed": [
    {
    "error": "string",
    "inputIndex": 0,
    "statusCode": 0,
    "externalInvoiceId": "string"
    }
    ]
    }
    }