API Documentation

Integrate SnapDoc into your workflow. Capture clean, structured data from documents using our simple REST API.

Description

This 'snap' works like a session. Creates a new scanning session and returns URLs for scanning, QR code, and document retrieval.

Parameters

Headers

Name	Description	Required
`CVS-Client-Code`	An ID to categorize snaps, for example OwnerID or ClientCode	Yes
`CVS-Client-Key`	Authentication key for the client	Yes
`Content-Type`	application/json	Yes

Request Body

Field	Description	Required
`referenceId`e.g. CVS-INV-00001	A local ID for the snap to refer it later, mostly is a new GUID (a unique reference)	Yes

Examples

Request

POST https://snapdoc.clearviewsys.com/api/snaps
Content-Type: application/json
CVS-Client-Code: OwnersClientCode
CVS-Client-Key: OwnersClientKey
{
    "referenceId": "CVS-INV-00001"
}

Response

{
    "snapId": "e5ffe601-ada6-49a1-844c-760352916878",
    "scannerUrl": ".../scan/e5ffe601-ada6-49a1-844c-760352916878",
    "getDocsUrl": ".../api/snaps/e5ffe601-ada6-49a1-844c-760352916878",
    "qrCodeUrl": ".../api/snaps/e5ffe601-ada6-49a1-844c-760352916878/qr",
    "uploadUrl": ".../api/snaps/e5ffe601-ada6-49a1-844c-760352916878/upload"
}