User Checks

Get a user check by ID

Changed on

Retrieves a check for a user specified by its ID.

get/users/{user_id}/checks/{check_id}

Request

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

Response

OK

OR
OR
OR
OR
OR

Changes

  • 079ede5fe507Revision changes
    • warning

      added the new SOLE_CUSTODY_PROOF enum value to the / response property for the response status

  • 210928eb221aRevision changes
    • breaking

      added subschema #6: User Check - US Withholding Tax Status to the response body oneOf list for the response status