--- title: "Get a user check by ID" method: GET path: "/users/{user_id}/checks/{check_id}" tags: ["User Checks"] --- # Get a user check by ID `GET /users/{user_id}/checks/{check_id}` Retrieves a check for a user specified by its ID. ## Response `200` OK - union - object — The KYC (Know your customer) check is completed by the client sharing the valid and relevant KYC data for the user. - `id` string, uuid, required — User Check unique identifier. - `user_id` string, uuid, required — User unique identifier. - `type` string, required — The type of check must be “KYC”. - `check_confirmed_at` string, date-time, required — Completion date and time of the KYC check. Must not be older than 24 months. - `data_download_link` string, url, required — Download URL for the KYC evidence file. The file size must not exceed 250 MB. - `document_type` 'PASSPORT' | 'ID_CARD' | 'RESIDENCE_PERMIT' | 'DRIVING_LICENSE' | 'TWO_PLUS_TWO_VERIFICATION_PROOF', required — The type of document used in the KYC process. * PASSPORT - Passport * ID_CARD - National Identification document * RESIDENCE_PERMIT - Residence Permit * DRIVING_LICENSE - Driving License * TWO_PLUS_TWO_VERIFICATION_PROOF - Two plus two verification proof (for GB residence users only) - `document_expiration_date` string, date — Expiration date of the document used in KYC process in YYYY-MM-DD format. **The field is required for the following document types:** * PASSPORT * ID_CARD * RESIDENCE_PERMIT * DRIVING_LICENSE - `nationality` string — Issuing country of the document used in the KYC process. [ISO 3166 alpha-2 codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). **The field is required for the following document types:** * PASSPORT * ID_CARD * RESIDENCE_PERMIT * DRIVING_LICENSE - `status` 'IN_PROGRESS' | 'PASSED' | 'FAILED', required — Final status of the KYC check. * IN_PROGRESS - KYC check is in progress * PASSED - KYC check passed * FAILED - KYC check failed - `provider` string, required — Provider that was used to perform the KYC check. - `method` 'VIDEO_ID' | 'IN_PERSON_ID' | 'ELECTRONIC_ID' | 'LIVENESS_PHOTO_ID' | 'QUALIFIED_ELECTRONIC_SIGNATURE_WITH_TX' | 'TWO_PLUS_TWO_VERIFICATION' | 'ID_COLLECTION', required — Method used for AML-compliant KYC process * VIDEO_ID - Video identification * IN_PERSON_ID - In-person identification at the post office or the client's outlet * ELECTRONIC_ID - Advanced electronic identification methods (namely German eID) * LIVENESS_PHOTO_ID - Photos and security features of the identification document in combination with a video-based liveness check (residence country must not be Germany in this case) * QUALIFIED_ELECTRONIC_SIGNATURE_WITH_TX - Qualified electronic signature accompanied by a bank transaction for verification * TWO_PLUS_TWO_VERIFICATION - A method of verifying identity by matching at least two personal details from two separate sources (for GB residence users only) * ID_COLLECTION - The identification document of the user is collected but has not undergone verification - `confirmed_address` object — Address. Must not be a P.O. box or c/o address. - `address_line1` string, required — First address line of the address. - `address_line2` string — Second address line of the address. - `postcode` string, required — Postal code (postcode, PIN or ZIP code) - `country` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW', required — Accepted country code. [ISO 3166-1 alpha-2 codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). - `state` string — State, province, county. [ISO 3166 alpha-2 Codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). - `city` string, required - `kyc_update` boolean — Marks this check as a KYC refresh/update as opposed to an initial record. - object — The PoR (Proof of residency) check is completed by the client sharing a valid PoR document, if not fulfilled by the KYC check. - `id` string, uuid, required — User Check unique identifier. - `user_id` string, uuid, required — User unique identifier. - `type` string, required — The type of check must be POR. - `check_confirmed_at` string, date-time, required — Completion date and time of the PoR check. - `issuance_date` string, date, required — Issuance date in YYYY-MM-DD format. - `data_download_link` string, url, required — Download URL for the PoR evidence file. The file size must not exceed 250 MB. - `document_type` 'UTILITY_BILL' | 'TELEPHONE_BILL' | 'INTERNET_BILL' | 'BANK_STATEMENT' | 'REGISTRATION_CERT' | 'RESIDENCE_PERMIT' | 'ID_CARD' | 'PASSPORT', required — The type of document used in the PoR process. Maximum age of the document is 12 months (stated on the document) applicable for: Utility bills (water, gas, electricity), Telephone bills (only landline), Internet bills, Bank account statements. Documents that need to be still valid - Registration certificate (must be valid and issued within the past 5 years), Residence permit e.g. Blue Card (as long as valid and contains the registration address), ID Card that contains the registration address. * UTILITY_BILL - * TELEPHONE_BILL - * INTERNET_BILL - * BANK_STATEMENT - * REGISTRATION_CERT - * RESIDENCE_PERMIT - * ID_CARD - * PASSPORT - - `status` 'IN_PROGRESS' | 'PASSED' | 'FAILED', required — Final status of the PoR check. * IN_PROGRESS - * PASSED - * FAILED - - `confirmed_address` object, required — Address. Must not be a P.O. box or c/o address. - `address_line1` string, required — First address line of the address. - `address_line2` string — Second address line of the address. - `postcode` string, required — Postal code (postcode, PIN or ZIP code) - `country` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW', required — Accepted country code. [ISO 3166-1 alpha-2 codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). - `state` string — State, province, county. [ISO 3166 alpha-2 Codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). - `city` string, required - object — Instrument fit check is completed by the client providing the user's answers to the instrument appropriateness or suitability questionnaire. - `id` string, uuid, required — User Check unique identifier. - `user_id` string, uuid, required — User unique identifier. - `type` string, required — The type of check must be INSTRUMENT_FIT. - `check_confirmed_at` string, date-time, required — Completion date and time of the instrument fit check. - `status` 'IN_PROGRESS' | 'PASSED' | 'FAILED', required — Final status of the instrument fit check. * IN_PROGRESS - Instrument fit check is in progress * PASSED - Instrument fit check passed * FAILED - Instrument fit check failed - `instrument_suitability` object, required - `suitability` boolean, required — Did the user go through a suitability assessment and the outcome indicated suitability. - object — Compliance check - `id` string, uuid, required — User Check unique identifier. - `user_id` string, uuid, required — User unique identifier. - `type` string, required — The type of check must be COMPLIANCE. - `status` 'IN_PROGRESS' | 'PASSED' | 'FAILED' — Final status of the COMPLIANCE check. * IN_PROGRESS - Compliance check is in progress * PASSED - Compliance check passed * FAILED - Compliance check failed - `check_confirmed_at` string, date-time, required — Completion date and time of the COMPLIANCE check. - object — The Guardian check is completed by the client providing documentation proving the guardian relationship with the child user. - `id` string, uuid, required — User Check unique identifier. - `user_id` string, uuid, required — User unique identifier. - `type` string, required — The type of check must be “GUARDIAN“. - `check_confirmed_at` string, date-time — Completion date and time of the PoR check. - `role_id` string, uuid, required — Unique identifier for the role that this guardian check is associated with. - `document_type` 'BIRTH_CERTIFICATE', required — The type of document used in the Guardian check. * BIRTH_CERTIFICATE - Birth certificate proving guardian relationship - `data_download_link` string, url, required — Download URL for the guardian evidence file. The file size must not exceed 250 MB. - `status` 'IN_PROGRESS' | 'PASSED' | 'FAILED', required — Final status of the Guardian check. * IN_PROGRESS - Guardian check is in progress * PASSED - Guardian check passed * FAILED - Guardian check failed ## Other responses - `401` — Unauthorized. The caller has not been authenticated. - `403` — Forbidden. The caller has been authenticated but is not allowed to take the requested action. - `404` — Not Found. The requested resource could not be found. - `406` — Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value. - `429` — Too Many Requests. The caller has exceeded their quota for the time period and has been throttled. - `500` — Internal Server Error. The service encountered an unexpected error. - `503` — Service Unavailable. The service handling for this request cannot be reached at this time. - `504` — Gateway Timeout. The service gateway has reached its internal timeout. --- [API](https://skmtc.net/upvest/apis/upvest-investment-api.md) · [All operations](https://skmtc.net/upvest/apis/upvest-investment-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/upvest/upvest-investment-api/revisions/eb94c0091916/schema)