Authentication

Authenticate your account when using the API by including your secret API key in the request. You can manage your API keys in the Outlay Dashboard. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Authentication to the API is performed via HTTP Basic Auth. Provide your API key as the basic auth username value. You do not need to provide a password.

Note: All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Create a Receipt

Creates a new receipt object. This endpoint triggers the asynchronous AI extraction engine. You will receive an immediate response with a receipt ID, but the extraction results (merchant name, amount, GST) will be populated asynchronously. Use webhooks to be notified when extraction completes.

Parameters

Name Type Description
file
Required 		binary The receipt image or PDF file to be processed. Max size 10MB.
workspace_id
Optional 		string The ID of the workspace. If not provided, defaults to your primary workspace.
cURL · Authentication 
curl https://api.outlay.site/v2/workspaces \
  -u sk_live_abc123...:
cURL · Create Receipt 
curl https://api.outlay.site/v2/receipts \
  -u sk_live_abc123...: \
  -F file=@/path/to/uber_receipt.pdf \
  -F workspace_id=ws_9x8y7z
JSON · Response 
{
  "id": "re_12345abc",
  "object": "receipt",
  "status": "processing",
  "created_at": 1694683059,
  "extracted_data": null
}