Skip to main content

AddDocumentResultSuccessResultResponse

Wraps a successful API response with the result payload.

correlationIduuid

A unique ID of the request

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

Indicates whether the request was successful. Always true for success responses.

Example: true
result object

Represents the result of a document submission, extending AddResult with document extraction info.

iduuid

The unique identifier of the created resource.

linkstringnullable

The URL link to access the created resource.

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

AddDocumentResultSuccessResultResponse
{
"correlationId": "fb0ccbbc-62bc-447f-a47e-02b490e25690",
"isSuccess": true,
"result": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"link": "string",
"documentExtractionInfo": {
"documentId": "string",
"extractionUrl": "string"
}
}
}