About this endpoint
What it does
Extracts receipt data from a document URL. You send a url, and the response returns a JSON object with a data object containing parsed output for azure and/or apyhub as defined by the output schema.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | A receipt document URL. Must be a valid URI. |
| azure | Object | No | Custom credentials for Azure services. Includes optional key, region, endpoint, account_id, and access_token fields. |
| azure.key | String | No | Azure subscription key. |
| azure.region | String | No | Azure service region. |
| azure.endpoint | String | No | Azure endpoint URL. |
| azure.account_id | String | No | Azure account ID. |
| azure.access_token | String | No | OAuth access token for Azure service. |
| requested_service | ENUM | No | Which extraction service to use. Allowed values: azure, apyhub. Default: apyhub. |
Response
Returns a JSON object with a data object field. The data object can contain azure and apyhub object fields, which hold the parsed receipt extraction output for the respective service.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| data | Object | No | Container for the extraction result. |
| data.azure | Object | No | Raw Azure Document Intelligence parsing output. |
| data.apyhub | Object | No | Structured ApyHub Receipt Extraction parsing output. |