Returns the paged list of clients, optionally filtered

GET

/baas/Clients

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://my.test-1.account.finlego.com/api/child-brand-integration/baas/Clients?PagedFilter.PageNumber=undefined&PagedFilter.PageSize=undefined&Sorting.SortBy=undefined&Sorting.SortOrder=undefined' \
--header 'Authorization: Bearer <token>'

Responses

🟢200

application/json

Bodyapplication/json

Example

{
    "data": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "externalId": "string",
            "state": "pending",
            "riskLevel": "low",
            "address": {
                "streetLine1": "string",
                "streetLine2": "string",
                "city": "string",
                "state": "string",
                "zip": "string",
                "country": "string"
            },
            "phoneNumber": "string",
            "email": "string",
            "type": "individual",
            "firstName": "string",
            "lastName": "string",
            "citizenshipCountry": "string",
            "identificationDocument": {
                "issuedBy": "string",
                "expirationDate": "2019-08-24",
                "type": "passport",
                "number": "string",
                "issuedCountryCode": "string",
                "issuedDate": "2019-08-24"
            },
            "residenceCountry": "string",
            "dateOfBirth": "2019-08-24"
        }
    ],
    "page": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalRecords": 0,
        "totalPages": 0
    }
}

🟠400

🟠404

🟠422

🔴500

Modified at 2026-09-21 17:52:32

Onboards a client using the JSON fields returned by the client creation fields endpoint.

Returns the OpenAPI 3.0 creation schema for the authenticated brand and requested type.