v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB

Sub-TPPs

Get all SubTpp documents

The GET /member/sub-tpps/{sub_tpp_id}/documents endpoint retrieves all documents for a SubTpp with optional filtering by status.

get/member/sub-tpps/{sub_tpp_id}/documents

Path parameters

sub_tpp_idstring required

Example:8d54f066-c14a-47c0-b58b-fec6b0ed6b4c

This id specifies the sub-TPP for which documents are to be retrieved.

Query parameters

statusesstring[]

Optional list of document statuses to filter results. If not provided, all documents are returned except those with WITHDRAWN and INVALID_DOCUMENT_STATUS.

Response

Successful response

Example response

{
  "documents": [
    {
      "id": "003b3342-3402-49b8-803d-4abe3f72b0a1",
      "member_id": "m:MWJgHAQNz53EMTjyNLuVnkqkBYU:5zKtXEAq",
      "sub_tpp_id": "df57627e-6c55-4f6e-b00a-0b0a234b098e",
      "document_name": "KYC/KYB Onboarding Process",
      "description": "Documented KYC/KYB onboarding process (if not already included in AML policy)",
      "file_id": "305de17e-f3f8-4a4f-84da-11059fbc838c",
      "created_at_ms": 1710000000000,
      "updated_at_ms": 1710000000000
    }
  ]
}