Check whether an existing personal USD account is a candidate for migration. This read is available in live and test environments. Eligibility does not guarantee initiation; execution is live-only and checks additional prerequisites.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
GET /bank_account/{account_id}/migration/eligibility
Authorization: Bearer <api_key>
Use the original account ID and its organisation's API key. The key determines the organisation and environment; follow the authentication requirements, including request signing where required.
{
"status": "success",
"message": "Bank account migration eligibility retrieved successfully",
"data": { "eligible": true },
"meta": null
}
data.eligible is a required boolean. The check identifies active personal USD accounts supported by the migration flow. Other accessible accounts return false.
This is a preliminary, read-only check, available in live and test environments. A true result does not guarantee initiation: execution is live-only and also requires autosweep, a zero balance, USD wallet settlement, and no conflicting active or pending USD account for the same holder. The migration guide explains the full process.
| HTTP status | Meaning |
|---|---|
| 200 | Eligibility returned; inspect data.eligible. |
| 400 | Account not found or outside the key's organisation/environment. |
| 401 | Authentication failed or the organisation is not permitted to access accounts. |
| 500 | Unexpected error; retry the read or contact Graph if it persists. |