About this endpoint
What it does
Extracts invoice data from a document available at a URL. The request sends the URL in the body, and the response returns a JSON object with a data object containing the parsing output for Azure and ApyHub.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | The invoice document URL to process. Must be a URI. |
| azure | Object | No | Custom credentials for Azure services. Contains optional Azure authentication 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 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 with parsing output for each service.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| data | Object | No | Response wrapper containing parsing results. |
| data.azure | Object | No | Raw Azure Document Intelligence parsing output. |
| data.apyhub | Object | No | Structured ApyHub Invoice Extraction parsing output. |