Get client state

GET

/baas/Clients/{id}/state

Returns the current state of a client. Use it to follow onboarding after POST /baas/Clients:

pending - onboarding is in progress;

active - onboarding is complete, and accounts can be opened;

creatingFailed - onboarding failed;

blocked or closed - the client has been blocked or closed.

The same onboarding outcome is reported with the onboardingCompleted and onboardingFailed webhooks.

Returns 404 Not Found if the client does not exist or belongs to another integrator.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Path Params

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

🟢200

application/json

Bodyapplication/json

Example

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "state": "pending"
}

🟠400

🟠404

🟠422

🔴500

Modified at 2026-09-29 12:10:42