v1

latestOpenAPI 3.0.02026-07-1361556.5 KB

VBA Documents

Get status for a previous benefits document upload

A request to the /uploads/{id} endpoint will return a real-time status for that GUID, and update its status in /uploads/report.\n\nThe updated_at field indicates the last time the status for a given GUID was updated.

get/uploads/{id}

Path parameters

idstring uuid required

ID as returned by a previous create upload request

Response

Upload status retrieved successfully

Example response

{
  "data": {
    "id": "6d8433c1-cd55-4c24-affd-f592287a7572",
    "type": "document_upload",
    "attributes": {
      "guid": "6d8433c1-cd55-4c24-affd-f592287a7572",
      "status": "error",
      "code": "DOC108",
      "detail": "Maximum page size exceeded. Limit is 78 in x 101 in.",
      "final_status": true,
      "updated_at": "2018-07-30T17:31:15.958Z"
    }
  }
}