Skip to main content
GET
List business clients

Authorizations

Authorization
string
header
required

JWT obtained from /v2/auth/login

Response

Business clients.

id
string<uuid>
required

Internal client identifier.

Example:

"550e8400-e29b-41d4-a716-446655440000"

name
string
required

Client name.

Example:

"Acme Bolivia"

type
enum<string>
required

Client type.

Available options:
individual,
company
Example:

"company"

status
enum<string>
required

Current client onboarding status.

Available options:
Pending,
Onboarding,
Active,
Rejected,
Suspended
Example:

"Active"

country
string
required

Client country code.

Example:

"BO"

email
string<email>
required

Client email address.

Example:

"client@example.com"

externalClientId
string | null
required

Client identifier in the external provider. It is null while the relationship does not exist.

Example:

null