Skip to content
Search! & Match! API
Import Document Response

Import Document Response

Import Document Response🔗


This object is a representation of a import document endpoint response.


Parameter Name Type Description
importId string The ID of the import operation
filename string Name of the uploaded document.
raw string External document as downloaded (Base64 encoded).
templated string Optional. External document formatted with customer's XML template defined in the Textkernel Parser (Base64 encoded). Returned only if the extraction is successful and templating is configured in the Textkernel Parser.
extractStatus string Status of the extraction operation (one of OK, FAIL, VALIDATION_ERROR)
message string Optional. Extraction error message. Returned only if the extraction is failed.


    "importId": "3fb91817a0424fbfb83b603245274609",
    "filename": "John Doe.docx",
    "raw": "PGRpdj48cCBzdHlsZT0ibWFyZ2luOjBwdDsgbGluZS1oZWlnaHQ6MTBwdDsgd2lkb3dzOjA7IG9ycGhhbnM6MC...",
    "templated": "PGRpdj48cCBzdHlsZT0ibWFyZ2luOjBwdDsgbGluZS1oZWlnaHQ6MTBwdDsgd2lkb3dzOjA7IG9ycGhhbnM6MC.."