User Checks

Get checks for a user

Changed on

Lists all checks for a user specified by ID.

get/users/{user_id}/checks

Request

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

Query parameters

list_historyboolean

If true, return the full history of checks (all records) instead of only the latest check per type.

type'KYC' | 'INSTRUMENT_FIT' | 'POR' | 'COMPLIANCE' | 'GUARDIAN' | 'USER_SELF_ASSESSMENT' | 'US_WITHHOLDING_TAX_STATUS'

Filter the returned checks to a single allowed check type (e.g. US_WITHHOLDING_TAX_STATUS).

Response

OK

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 property oneOf list for the response status