ID Data Extraction turns an ID document into structured parsing output. Send a PDF or image by URL or upload a file, and choose whether you want ApyHub extraction or raw Azure Document Intelligence output.
Use the /url endpoint when the document lives at a public URL, or /file when you have the document in hand. The request body accepts a requested_service value of apyhub or azure. If you use Azure, you can also pass custom credentials such as azure.key, azure.region, azure.endpoint, azure.account_id, or azure.access_token on the URL flow, and the equivalent Azure fields on the file upload flow.
The response is returned under data, with separate objects for apyhub and azure. That makes it straightforward to plug into onboarding flows, identity verification steps, document intake pipelines, or back-office review tools where you need machine-readable ID parsing rather than manual data entry.
Use ID Data Extraction when you need to extract and route identity document data from an uploaded file or a document URL without building your own parsing layer.
Call this endpoint with your ApyHub API key:
curl -X POST "https://api.eu.apyverse.com/apyhub/extract-id-data/url" \
-H 'apy-token: $APY_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"azure":{"access_token":"access_token_value","account_id":"account-id-1234","endpoint":"https://westus2.api.cognitive.microsoft.com/","key":"your_azure_speech_or_vision_key","region":"westus2"},"requested_service":"apyhub","url":"https://assets.apyhub.com/samples/sample-id.jpg"}'Loading your default key…Extract id data (URL input)
Analyze id at the provided URL. Note: The optional 'requested_service' selector and 'azure' configuration fields are omitted in this basic example for simplicity.
Documentation imported from spec — please review and complete before submitting.
Upload an ID file to extract data from it.
curl -X POST "https://api.eu.apyverse.com/apyhub/extract-id-data/file" \
-H "apy-token: $APY_TOKEN" \
-F "file=@/path/to/id-document.pdf"Returns a JSON object with a data object. Inside data, the API may include an azure object with the raw Azure Document Intelligence output and an apyhub object with the structured ApyHub ID extraction output.
{
"data": {
"azure": {},
"apyhub": {}
}
}Loading your default key…Uploads a file and extracts ID data from it. The response returns a JSON object with a data object containing parsing results from azure, apyhub, or both, depending on the request.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| file | String | Yes | The file to upload. Format: binary. |
| azure_key | String | No | Azure key used for Azure Document Intelligence authentication. |
| azure_region | String | No | Azure region value, such as eastus. |
| azure_endpoint | String | No | Azure endpoint URL. |
| azure_account_id | String | No | Azure account identifier. |
| requested_service | ENUM | No | Service to use for extraction. Allowed values: azure, apyhub. Default: apyhub. |
| azure_access_token | String | No | Azure access token. |
Returns a JSON object with a data object field. Inside data, the response may include azure and/or apyhub object fields containing the parsing output for each service.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| data | Object | No | Container for the extraction result objects. |
| data.azure | Object | No | Raw Azure Document Intelligence parsing output. |
| data.apyhub | Object | No | Structured ApyHub ID Extraction parsing output. |
Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.
bad_requestRequired parameter missing or malformed body.
unauthorizedAPI key missing, revoked, or not authorized for this service.
rate_limitedYour plan's per-second rate exceeded. Retry with exponential backoff.
upstream_busyBackend temporarily unavailable. Try again in a few seconds.