Arf Liquidity Docs
  1. Client
Arf Liquidity Docs
  • Introduction
  • Environments
  • IP Restrictions
  • Authentication
  • RSA4096 Examples
  • Errors
  • Webhooks
  • Client
    • Create Client
      POST
    • Upload Document
      PUT
    • Get Client
      GET
    • List Clients
      GET
    • Get Client Credit Preference
      GET
    • Create Bank Information
      POST
    • Create Chain Information
      POST
  • Credit
    • Check Credit
      GET
    • Create Credit
      POST
    • Get Credit
      GET
    • List Credits
      GET
  • Webhooks
    • List All Webhook
      GET
    • Create Webhook
      POST
    • Delete Webhook
      DELETE
  • Schemas
    • Error Schema
    • Successful Response
    • Client Detail
    • Document Detail
    • Credit Details
    • Webhook
  1. Client

List Clients

GET
/v1/clients
Last modified:2025-07-10 10:20:42
Retrieves a list of all previously created client profiles.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/clients?status=pending_review, pending_documents, document_review, rejected, approved&credit_status=active,inactive&created_at.from&created_at.to&page&size&direction' \
--header 'Authorization: Bearer <token>'
Response Response Example
{
    "status": "string",
    "timestamp": "string",
    "data": {
        "page": 0,
        "size": 0,
        "direction": "string",
        "clients": [
            {
                "id": "string",
                "name": "string",
                "status": "string",
                "credit_status": "string",
                "created_at": "string",
                "email": "string",
                "country": "string",
                "address": "string",
                "currency": "string",
                "bank_information": {
                    "iban": "string",
                    "account_number": "string",
                    "swift_code": "string"
                },
                "documents": [
                    {
                        "name": "string",
                        "key": "string",
                        "status": "string",
                        "reason": "string"
                    }
                ]
            }
        ]
    }
}
Modified at 2025-07-10 10:20:42
Previous
Get Client
Next
Get Client Credit Preference
Built with