Skip to navigation
REST API EndpointsUsers

Get Partner Subaccount Request Status

View as Markdown

Check the status of a subaccount request.

Available to: Organization administrators

Environments: Production

Rate Limit: Although this endpoint does not have a rate limit, you should implement appropriate polling intervals (e.g., every 30-60 seconds) to avoid unnecessary load.

Poll this endpoint to track the progress of a subaccount request through the approval workflow. The request progresses through various statuses as it is reviewed by internal operations teams.

Warning: This endpoint returns HTTP 200 for successes and business errors. Always check the errorText field in the response body to determine whether the request succeeded or failed.

subAccountRequestId

For subAccountRequestId, use the requestId returned from createpartnersubaccountrequest.

Status Progression

Requests typically progress through statuses in this order: Preapproved → InReview → InAMLReview (if applicable) → Approved or Denied

  • Status changes may not be immediate.
  • InAMLReview means the request is being reviewed by the Anti-Money Laundering (AML) team.
  • If the subaccount request is Denied, check the message field for the reason.

Common Failure Scenarios

  • Invalid or non-existent subAccountRequestId
  • subAccountRequestId belongs to a different organization
  • Non-admin user attempting to call the endpoint

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
subAccountRequestIdlongRequired

Response

PartnerSubAccountRequestStatusResponse
errorTextstringOptional<=8192 characters

Non-empty if the request failed

requestIdlongOptional
statusenumOptional
Approved, Denied, InAMLReview, InReview, Pending, Preapproved
messagestringOptional<=8192 characters
accountIdlongOptional