Get Subclient Documents

Request

Path Params

clientId

string

required

Client's ID

id

string

required

SubClient's ID

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api-gateway-uat.mmacs.io/platform/client-service/api/v1/clients//sub-clients//documents'

Responses

🟢200OK

application/json

success response

Body

DocumentOutputArray type

message

string

required

the response message

count

number

optional

the data count

documents

array[object (DocumentOutputData) {22}]

required

the response data object

id

number

optional

The id of the client

entityId

string

required

The entity ID of the client (nanoid)

createdAt

string

optional

The date the entity was created

updatedAt

string

optional

The last date the entity was updated

createdBy

string

optional

The email of the user who created the entity

updatedBy

string

optional

The email of the user who last updated the entity

isDeleted

string

optional

Check if the entity has been deleted (soft delete)

documentType

string

required

The type of document

uploadedFiles

array[string]

required

The urls of the uploaded files

description

string

required

issueDate

string

optional

The issue date of the document

expiryDate

string

optional

The expiry date of the document

documentNumber

string

optional

The number of the document

documentOwner

string

required

approvalStatus

string

optional

The document approval status

mimeType

string

optional

The mime type of the document

parentType

enum<string>

optional

Allowed values:

clientsubclientshareholder

isExpired

boolean

optional

expiryNotificationSent

boolean

optional

lastNotificationSentAt

string

optional

expiryStatus

string

optional

comment

string

optional

Example

{
    "message": "Document fetched successfully",
    "documents": [
        {
            "id": "664",
            "entityId": "NtfQFYYn7lAovbKAcWUzb",
            "createdAt": "2025-05-30T05:15:48.727Z",
            "updatedAt": "2025-05-30T05:15:48.727Z",
            "createdBy": "abc.def@yopmail.com",
            "updatedBy": null,
            "isDeleted": false,
            "documentType": "REGISTRATION_CERTIFICATE",
            "uploadedFiles": [
                "https://boltsendblolb.blob.core.windows.net/others/fbqi6H6XUIGm9L-image%20(8).png?sv=2024-11-04&spr=https%2Chttp&st=2025-05-30T06%3A15%3A48Z&se=2025-05-30T07%3A15%3A48Z&sr=b&sp=r&sig=jwxB%2B3NxN0kTFEK5UWqV4kGYaCrjB6ISoYjWL%2F7D5OY%3D"
            ],
            "description": "registration_certificate",
            "issueDate": null,
            "expiryDate": null,
            "documentNumber": null,
            "documentOwner": "company",
            "approvalStatus": null,
            "mimeType": "image/png",
            "parentType": "subclient",
            "isExpired": false,
            "expiryNotificationSent": false,
            "lastNotificationSentAt": null,
            "expiryStatus": null,
            "comment": null
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized