COcolumntax

Tax Refund Unlock Status

Changed on
get/v1/users/{id}/status

Request

  • Base URL
    https://sandbox.columnapi.com
  • URL
    https://sandbox.columnapi.com/v1/users/{id}/status
  • Auth
    HTTP basic

Path parameters

idstring required

The unique identifier for the user. The same identifier used to create the user via a call to /v1/users.

Response

200

should_switch_direct_depositboolean
switched_direct_depositboolean
statusstring
forecasted_unlocked_amount_centsinteger

Example response

{
  "should_switch_direct_deposit": true,
  "switched_direct_deposit": true,
  "status": "finished_success",
  "forecasted_unlocked_amount_cents": 14558
}

Changes