Export Smart Holder List
This API allows a Studio (submitter) to export as a CSV file the full list of companies (holders) it manages, filtered by their status. It is the main way to download the holder list when preparing or reviewing smart activations.
Why This API Exists​
The TS Archive system supports a concept called smart activation, which enables simplified and automated archival flows for companies managed by a Studio. Each company (holder) can be in a different stage of that activation process.
This API exists so that consumers can extract a filtered snapshot of the holder list. For example, to see which companies are still waiting for certification, which have been validated.
Smart Activation Statuses​
Each holder can be in one of the following statuses:
| Status | Meaning |
|---|---|
INITIALIZED | Smart activation has been started but not yet submitted for certification. |
TOBE_CERTIFIED | Submitted and awaiting certification. |
REJECTED | Certification was rejected. |
MISSING | Required data is incomplete or missing. |
VALIDATED | Smart activation has been validated and is active. |
VALIDATED_WITH_DRAFT | Validated, but a draft modification is pending. |
VALIDATED_WITH_DRAFT_TOBE_CERTIFIED | Validated with a draft submitted for re-certification. |
VALIDATED_WITH_DRAFT_REJECTED | Validated but the pending draft was rejected. |
Use Cases​
Use this API when you need to:
- Export a list of holders filtered by smart activation status for reporting or verification.
- Prepare a bulk review of companies that need attention (e.g.
REJECTEDorMISSING). - Monitor smart activation progress across all companies managed by a Studio.
- Feed downstream processes that consume holder lists in CSV format.
How to Use the API​
Endpoint​
POST /api/v1/config/smart-holder-list/export
Swagger reference: [Smart Holder List Export]
Authentication​
Authentication is required. Refer to the Authentication page for how to obtain and use a valid JWT token.
Allowed security roles: M2M, User, Backoffice
Headers​
All standard headers are required for this request. Refer to the Standard Headers page for the full list and their descriptions.
Request Body​
Content-Type: application/json
The request body must have the following format:
{
"status_filter": "INITIALIZED",
"text_search": "string",
"submitter_uuid": "string",
"nextPageRequest": {
"sourcePage": 0
}
}
Fields:
status_filter(string, optional) — Filter holders by smart activation status. Accepted values:INITIALIZED,TOBE_CERTIFIED,REJECTED,MISSING,VALIDATED,VALIDATED_WITH_DRAFT,VALIDATED_WITH_DRAFT_TOBE_CERTIFIED,VALIDATED_WITH_DRAFT_REJECTED. If omitted, all statuses are included.text_search(string, optional) — Free-text search applied against holder name or identifier.submitter_uuid(string, optional) — UUID of the submitter (Studio) whose holders should be exported. Required when calling asM2MorBackoffice.nextPageRequest.sourcePage(integer, optional) — Zero-based page index for paginated exports. Use0for the first page.
Responses​
200 OK — CSV file returned​
The response body is a CSV file containing the list of holders matching the search criteria.
"string"
The response is a binary stream representing the CSV content.
400 Bad Request​
One or more parameters provided in the request are incorrect, or required parameters are missing.
{
"timestamp": "2026-02-24T14:16:14.292Z",
"status": "CONTINUE",
"code": "string",
"message": "string"
}
401 Unauthorized​
The provided credentials are not correct.
{
"timestamp": "2026-02-24T14:16:14.293Z",
"status": "CONTINUE",
"code": "string",
"message": "string"
}
403 Forbidden​
The authenticated caller does not have the required permissions to perform this operation.
{
"timestamp": "2026-02-24T14:16:14.294Z",
"status": "CONTINUE",
"code": "string",
"message": "string"
}
API Reference​
Use the links below to open the interactive OpenAPI (Swagger) documentation for this endpoint in each environment.