Tax Residencies

Retrieve tax residencies

Returns the tax residencies currently on file for the user identified by user_id.

See the User tax onboarding guide (TOL / BYOL) for tax residency requirements.

get/users/{user_id}/tax_residencies

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/users/{user_id}/tax_residencies
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: taxes:read, taxes:admin)

Response

User tax residencies

created_atstring date-time required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

updated_atstring date-time required

Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC

status'PENDING' | 'ACTIVE' required

Tax residency status

  • PENDING - It indicates that the tax residency records are not yet processed by Upvest.
  • ACTIVE - It indicates that tax residency records are processed, and the tax residency record is the one in use.

Changes

No recorded changes to this operation across all 25 revisions of this API.