Skip to main content
GET
/
apex
/
accounts
/
by-request
/
{request_id}
curl https://api.yoshi.ai/apex/accounts/by-request/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer yoshi_3xK9mP..."
{
  "status": "ready",
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "account": {
    "id": "acc_brok_abc123",
    "name": "Brokerage Account",
    "type": "investment",
    "subtype": "brokerage",
    "status": "active",
    "external_id": "ext_apex_456",
    "external_source": "apex",
    "apex_account_number": "8AA000001",
    "as_of": "2026-04-15T12:00:00.000Z",
    "created_at": "2026-04-15T12:00:00.000Z",
    "updated_at": "2026-04-15T12:00:00.000Z"
  },
  "staging_account": {
    "id": "stg_abc123",
    "account_number": "8AA000001",
    "apex_person_id": "apx_person_789",
    "apex_state": "COMPLETE",
    "description": "Long-term investments",
    "owner_user_id": "usr_xyz",
    "as_of": "2026-04-15T12:00:00.000Z",
    "created_at": "2026-04-15T12:00:00.000Z",
    "updated_at": "2026-04-15T12:00:00.000Z"
  },
  "staging_person": {
    "id": "stg_person_789",
    "owner_user_id": "usr_xyz",
    "status": "COMPLETE",
    "created_at": "2026-04-15T12:00:00.000Z",
    "updated_at": "2026-04-15T12:00:00.000Z"
  }
}
Use this endpoint to check the progress of a brokerage account creation that returned a 202 response. Poll until the status field is "ready" or "failed".

Path parameters

request_id
string
required
The request_id you provided when creating the brokerage account.

Response

The response always returns HTTP 200 with a status field indicating the current state of the request.

status: "ready"

The account was created successfully. The response includes the full account details.
status
string
"ready" — the account is ready.
request_id
string
The request identifier.
account
object
The canonical account record. See Create brokerage account for field details.
staging_account
object
The staging record for the Apex account. See Create brokerage account for field details.
staging_person
object
The staging record for the associated Apex person. See Create brokerage account for field details.

status: "pending"

The account is still being created.
status
string
"pending" — creation is in progress.
request_id
string
The request identifier.

status: "failed"

The account creation failed.
status
string
"failed" — creation did not succeed.
request_id
string
The request identifier.
error
string
A description of why the account creation failed.

Error responses

StatusDescription
403The brokerage account feature is not enabled for your account.
404No account creation request found for the given request_id.
curl https://api.yoshi.ai/apex/accounts/by-request/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer yoshi_3xK9mP..."
{
  "status": "ready",
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "account": {
    "id": "acc_brok_abc123",
    "name": "Brokerage Account",
    "type": "investment",
    "subtype": "brokerage",
    "status": "active",
    "external_id": "ext_apex_456",
    "external_source": "apex",
    "apex_account_number": "8AA000001",
    "as_of": "2026-04-15T12:00:00.000Z",
    "created_at": "2026-04-15T12:00:00.000Z",
    "updated_at": "2026-04-15T12:00:00.000Z"
  },
  "staging_account": {
    "id": "stg_abc123",
    "account_number": "8AA000001",
    "apex_person_id": "apx_person_789",
    "apex_state": "COMPLETE",
    "description": "Long-term investments",
    "owner_user_id": "usr_xyz",
    "as_of": "2026-04-15T12:00:00.000Z",
    "created_at": "2026-04-15T12:00:00.000Z",
    "updated_at": "2026-04-15T12:00:00.000Z"
  },
  "staging_person": {
    "id": "stg_person_789",
    "owner_user_id": "usr_xyz",
    "status": "COMPLETE",
    "created_at": "2026-04-15T12:00:00.000Z",
    "updated_at": "2026-04-15T12:00:00.000Z"
  }
}
Last modified on April 16, 2026