Endpoint for getting the status for inbound files

GET /api/v3.0/{engagementSid}/files/{inboundFileCategory}/{uniqueFileName}/status
Adra personal access token & Adra oauth code pkce & Adra oauth client cred

Check the processing status of a file previously uploaded to Integration Hub. This endpoint allows you to track the progress of file processing.

Status Flow

Files progress through the following states:

  1. Receiving: Initial upload in progress
  2. Queued: File received and waiting for processing
  3. Processing: File is being validated and processed
  4. WaitingInteraction: Processing paused, waiting for user input
  5. PartiallySucceeded: Some records processed with errors
  6. Succeeded: All records processed successfully
  7. Failed: Processing failed
  8. Discarded: File processing was cancelled or discarded
  9. Unknown: Status cannot be determined

Response Details

Returns a JSON object containing:

  • uniqueFileName: The file identifier
  • status: Current processing state
  • submittedTime: When the file was uploaded
  • finishedTime: When processing completed (null if not finished)

Common Use Cases

  • Polling for completion status
  • Error checking before retry
  • Monitoring processing progress

Best Practices

  • Poll at reasonable intervals
  • Implement exponential backoff
  • Handle all possible status values

Error Responses

  • 404: File not found
  • 403: Insufficient permissions
  • 401: Invalid authentication

Note: Files are typically processed within 5 minutes, depending on size and complexity.

Headers

  • x-gw-stloc-hint string

    Optional HTTP header to optimize request routing and reduce latency. Possible values: EUWE-01 (West Europe), AUEA-01 (Australia East), USEA-01 (East US), NO01 (Norway East).

Path parameters

  • engagementSid string Required

    Short identifier for engagement (as in URLs)

  • inboundFileCategory string Required

    Specifies the category of the inbound file for status checking. Only a subset of inbound file categories support status checking.

    Values are MatcherTransactionUpload or LegalEntityUpload.

  • uniqueFileName string Required

    The name of the file

Responses

  • 200 application/json

    Success

    Hide response attributes Show response attributes object
    • uniqueFileName string Required
    • status string Required

      Values are Receiving, Queued, Processing, PartiallySucceeded, Succeeded, Failed, Rejected, WaitingInteraction, Discarded, Deleted, or Unknown.

    • submittedTime string(date-time) Required
    • finishedTime string(date-time) | null
  • 400 application/problem+json

    Bad Request: see problem details for more information

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
  • 401 application/problem+json

    Unauthorized: Missing an authorization header or token, or the token has expired

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
  • 403 application/problem+json

    Forbidden: You don't have access to the engagement, the engagement doesn't have IH or you don't have IH access on the engagement

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
  • 500 application/problem+json

    Internal Server Error

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
  • default application/problem+json

    Error

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
GET /api/v3.0/{engagementSid}/files/{inboundFileCategory}/{uniqueFileName}/status 
curl \
 --request GET 'https://integrationhub.adra.com/api/v3.0/{engagementSid}/files/{inboundFileCategory}/{uniqueFileName}/status' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "x-gw-stloc-hint: string"
Response examples (200) 
{
  "uniqueFileName": "string",
  "status": "Receiving",
  "submittedTime": "2025-05-04T09:42:00Z",
  "finishedTime": "2025-05-04T09:42:00Z"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (401) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (403) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (500) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (default) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}