Enrichment API
Was this helpful?
Was this helpful?
Get the enrichment result using the polling ID. Returns the result in the format requested.
Account registration number issued by Qvalia
""The unique polling ID for the file
""The enrichment type sent on posting of the document
capturePossible values: GET /enrichment/{accountRegNo}/{pollingId}/{enrichmentType} HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Accept: */*
{
"status": "text",
"data": {
"result": {},
"errors": [],
"warnings": []
}
}This endpoint allows clients to check the status of an invoice file’s enrichment process using a polling ID. Since enrichment is an asynchronous operation, this endpoint should be used to monitor progress and retrieve results once processing is complete.
Polling Behavior
If the enrichment process is still ongoing, the API will return HTTP 202 (Accepted), indicating that the request was received and is still being processed.
Once the enrichment is complete, the API will return HTTP 200 (OK) along with the final result.
Clients must limit polling requests to once every 30 seconds. Requests made at a higher frequency may be rate-limited or rejected
Account registration number issued by Qvalia
""The unique polling ID for the file
""GET /enrichment/{accountRegNo}/{pollingId} HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Accept: */*
{
"status": "text",
"data": {
"capture": {
"result": {
"Invoice": {}
},
"errors": [],
"warnings": []
}
}
}API accepts a single invoice file (PDF or XML) and processes it asynchronously. Returns a polling ID to check the status of enrichment. Send the pollingId to the enrchment GET endpoint to get the status or completed result.
The Enrichment API is billed separately hence require additional permissions to be enabled. Please contact Qvalia support if you require access.
Account registration number issued by Qvalia
""Optional name of the file being uploaded, including extension (e.g., invoice.pdf).
invoice.pdfThe Base64 encoded content of the file.
UEsFBgAAAAAAAAAAAAAAAAAAAAAAAA==types of enrichment tasks to perform. Ex; "capture"
capturePOST /enrichment/{accountRegNo}/invoice HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 103
{
"fileName": "invoice.pdf",
"fileContent": "UEsFBgAAAAAAAAAAAAAAAAAAAAAAAA==",
"enrichmentTypes": "capture"
}{
"status": "text",
"data": {
"pollingId": "text"
}
}