SUsurense
Data Import

Get a data import record

Returns a data import record of the caller's tenant: its provider, files, parameters, status (INITIATED → UPLOADED → PROCESSING → PROCESSED / FAILED), per-file results (counts, info/warning/error messages), failure reason and revert information. Poll this endpoint to follow the progress of an import after starting it.

Authorization: any authenticated user; the record must belong to the caller's tenant.

Errors: an unknown record id (or a record of another tenant) returns 400, not 404.

get/data-import/{id}

Request

  • Base URL
    https://api.surense.com/api/v1
  • URL
    https://api.surense.com/api/v1/data-import/{id}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.surense.com/oauth/token

Path parameters

idstring uuid required

Data import record ID (UUID), as returned by initiateDataImport

Response

The data import record

tenantIdstring uuid
agencyIdstring uuid

Agency the data is imported into.

createdDatestring date-time
createdBystring uuid
creatorNamestring
lastModifiedDatestring date-time
lastModifiedBystring uuid
versioninteger
idstring uuid

Data import record ID.

providerstring uuid

ID of the import provider.

subProviderstring uuid

ID of the resolved sub-provider, when the provider has sub-providers.

paramsobject

The provider-specific parameters given at initiation (e.g. subProvider, validityMonth, customerManager).

status'INITIATED' | 'UPLOADED' | 'PROCESSING' | 'PROCESSED' | 'FAILED'

Import status: INITIATED (waiting for upload), UPLOADED (queued), PROCESSING, PROCESSED or FAILED.

failureReasonstring

Why the import failed, when status is FAILED.

revertedBystring uuid

ID of the user who reverted the import, if reverted.

revertedAtstring date-time

When the import was reverted, if reverted.

Example response

{
  "agencyId": "8d0f6a52-1c3e-4b7a-9f25-6e4d3c2b1a90",
  "id": "3f2b8c1e-7d4a-4e9b-9c61-0a5d2e8f4b17",
  "provider": "5a7c9e21-4b3d-4f8a-8e6c-2d1b0a9f8e74",
  "subProvider": "c4e2a7b9-0d1f-4a6e-b8c3-9f7e5d3b1a26",
  "status": "PROCESSED",
  "revertedBy": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
  "revertedAt": "2026-10-12T08:45:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.