# Create a new check for a user Creates a new check for a user specified by ID. Endpoint: POST /users/{user_id}/checks Version: 1.144.0 Security: oauth-client-credentials ## Path parameters: - `user_id` (string, required) The unique identifier of the user. Universally Unique Identifier (UUID). ## Header parameters: - `upvest-client-id` (string, required) Your client ID, issued by Upvest. Identifies the client making the request. Universally Unique Identifier (UUID). - `Authorization` (string, required) Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750 - `signature` (string, required) https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header - `signature-input` (string, required) https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he - `upvest-api-version` (string) Upvest API version (Note: Do not include quotation marks) ## Request fields (application/json): - `type` (string, required) The type of check must be “KYC”. - `check_confirmed_at` (string, required) Completion date and time of the KYC check. Must not be older than 24 months. - `data_download_link` (string, required) Download URL for the KYC evidence file. The file size must not exceed 250 MB. - `document_type` (string, 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) Enum: "PASSPORT", "ID_CARD", "RESIDENCE_PERMIT", "DRIVING_LICENSE", "TWO_PLUS_TWO_VERIFICATION_PROOF" - `document_expiration_date` (string) 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 - `provider` (string, required) Provider that was used to perform the KYC check. - `method` (string, 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 Enum: "VIDEO_ID", "IN_PERSON_ID", "ELECTRONIC_ID", "LIVENESS_PHOTO_ID", "QUALIFIED_ELECTRONIC_SIGNATURE_WITH_TX", "TWO_PLUS_TWO_VERIFICATION", "ID_COLLECTION" - `confirmed_address` (object) Address. Must not be a P.O. box or c/o address. - `confirmed_address.address_line1` (string, required) First address line of the address. - `confirmed_address.address_line2` (string) Second address line of the address. - `confirmed_address.postcode` (string, required) Postal code (postcode, PIN or ZIP code) - `confirmed_address.country` (string, required) Accepted country code. [ISO 3166-1 alpha-2 codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Enum: "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" - `confirmed_address.state` (string) State, province, county. [ISO 3166 alpha-2 Codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). - `confirmed_address.city` (string, required) - `kyc_update` (boolean) Marks this check as a KYC refresh/update as opposed to an initial record. - `type` (string, required) The type of check must be POR. - `check_confirmed_at` (string, required) Completion date and time of the PoR check. - `issuance_date` (string, required) Issuance date in YYYY-MM-DD format. - `data_download_link` (string, required) Download URL for the PoR evidence file. The file size must not exceed 250 MB. - `document_type` (string, 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 - Enum: "UTILITY_BILL", "TELEPHONE_BILL", "INTERNET_BILL", "BANK_STATEMENT", "REGISTRATION_CERT", "RESIDENCE_PERMIT", "ID_CARD" - `type` (string, required) The type of check must be INSTRUMENT_FIT. - `check_confirmed_at` (string, required) Completion date and time of the instrument fit check. - `instrument_suitability` (object, required) Outcome of the user's instrument suitability assessment. - `instrument_suitability.suitability` (boolean, required) Did the user go through a suitability assessment and the outcome indicated suitability. - `type` (string, required) The type of check must be “GUARDIAN“. - `role_id` (string, required) Unique identifier for the role that this guardian check is associated with. - `document_type` (string, required) The type of document used in the Guardian check. * BIRTH_CERTIFICATE - Birth certificate proving guardian relationship Enum: "BIRTH_CERTIFICATE" - `data_download_link` (string, required) Download URL for the guardian evidence file. The file size must not exceed 250 MB. - `type` (string, required) The type of check must be "USER_SELF_ASSESSMENT". - `check_confirmed_at` (string, required) The date and time when the self assessment information was provided by the end user. - `user_occupation` (string, required) The user's employment/occupation status. Enum: "EMPLOYEE", "HOMEMAKER", "PENSIONER", "PUBLIC_OFFICIAL", "UNEMPLOYED", "SELF_EMPLOYED_FREELANCER", "STUDENT", "TRAINEE", "OTHER" - `user_industry` (string, required) The industry the user is professionally active in. Enum: "AGRICULTURE_FORESTRY_AND_FISHING", "MANUFACTURING", "UTILITIES_AND_ENERGY", "WHOLESALE_TRADE", "RETAIL_TRADE", "TRANSPORTATION_AND_LOGISTICS_RAIL_AND_STORAGE", "INFORMATION_TECHNOLOGY_AND_MEDIA_PRINT_PUBLISHING", "ADMIN_AND_SUPPORT_SERVICES_CLEANING_AND_FACILITIES", "EDUCATION_HIGHER_EDUCATION", "ENTERTAINMENT_ARTS_AND_RECREATION_NATURE_AND_ZOOS", "EXTRATERRITORIAL_AND_HOUSEHOLD_ACTIVITIES", "MANUFACTURING_PHARMACEUTICALS", "CONSTRUCTION", "RETAIL_TRADE_SPECIALITY", "WHOLESALE_TRADE_INDUSTRIAL", "TRANSPORTATION_AND_LOGISTICS", "ACCOMMODATION_AND_HOSPITALITY", "INFORMATION_TECHNOLOGY_AND_MEDIA", "REAL_ESTATE", "PROFESSIONAL_AND_TECHNICAL_SERVICES", "ADMIN_AND_SUPPORT_SERVICES", "PUBLIC_ADMINISTRATION", "EDUCATION", "HEALTHCARE", "ENTERTAINMENT_ARTS_AND_RECREATION", "PERSONAL_AND_OTHER_SERVICES", "MINING_AND_QUARRYING", "MANUFACTURING_WEAPONS_AND_HAZARDOUS", "MANUFACTURING_PRECIOUS_METALS_AND_JEWELLERY", "RETAIL_TRADE_SPECIFIC_SECTORS", "WHOLESALE_TRADE_PETROLEUM_AND_CHEMICALS", "WHOLESALE_TRADE_LUXURY_AND_COLLECTIBLES", "INFORMATION_TECHNOLOGY_AND_MEDIA_TELECOMMUNICATIONS", "TRANSPORTATION_AND_LOGISTICS_CRUISE_LINES", "ACCOMMODATION_AND_HOSPITALITY_TIMESHARING", "FOOD_AND_BEVERAGE_SERVICES", "INFORMATION_TECHNOLOGY_AND_MEDIA_ONLINE_GAMING", "FINANCIAL_SERVICES", "REAL_ESTATE_AGENCY_AND_BROKERAGE", "PROFESSIONAL_AND_TECHNICAL_SERVICES_LEGAL_AND_FIDUCIARY", "PROFESSIONAL_AND_TECHNICAL_SERVICES_UNREGULATED", "ADMIN_AND_SUPPORT_SERVICES_SPECIFIC_SECTORS", "ADMIN_AND_SUPPORT_SERVICES_SECURITY_AND_INVESTIGATION", "PUBLIC_ADMINISTRATION_JUDICIAL", "HEALTHCARE_COUNSELLING_AND_SOCIAL_SERVICES", "ENTERTAINMENT_ARTS_AND_RECREATION_SPECIFIC_SECTORS", "PERSONAL_AND_OTHER_SERVICES_NONPROFIT_AND_MEMBERSHIP_ORGANISATIONS", "PERSONAL_AND_OTHER_SERVICES_ADULT_AND_WELLNESS", "OTHER" - `yearly_gross_income` (object, required) A monetary range defined by a lower bound and an optional upper bound. - `yearly_gross_income.currency` (string, required) Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling Enum: "EUR", "GBP" - `yearly_gross_income.lower_bound` (number, required) The lower bound of the monetary range. - `yearly_gross_income.upper_bound` (number) The upper bound of the monetary range. - `income_sources` (array, required) The user's sources of income. More than one may apply. - `type` (string, required) The type of check must be "US_WITHHOLDING_TAX_STATUS". - `check_confirmed_at` (string, required) The date and time when the US withholding tax status was confirmed. - `data_download_link` (string) Download URL for the withholding status evidence file. Only required when `documentation_type` is "W8-BEN" or "W9", and only when your operating model requires supporting documents to be supplied to Upvest. The file size must not exceed 250 MB. - `person_type` (string, required) US tax person classification of the user. * US_PERSON - The user is a US person for tax purposes. * NON_RESIDENT_ALIEN - The user is a non-resident alien for US tax purposes. Enum: "US_PERSON", "NON_RESIDENT_ALIEN" - `documentation_type` (string, required) Type of documentation supporting the US withholding tax status. * KYC - Withholding status derived from the existing KYC data (non-resident aliens only). * W8-BEN - IRS Form W-8BEN provided by the user (non-resident aliens only). * W9 - IRS Form W-9 provided by the user (US persons only). * UNDOCUMENTED - No documentation is available for the user. For a non-resident alien, "KYC" is accepted for every operating model; whether "W8-BEN" and "UNDOCUMENTED" are also accepted depends on your operating model. Enum: "KYC", "W8-BEN", "W9", "UNDOCUMENTED" - `valid_from` (string, required) The date from which the US withholding tax status is valid, in YYYY-MM-DD format. - `valid_to` (string) The date until which the US withholding tax status is valid, in YYYY-MM-DD format. Null if the status has no defined end date. ## Response 202 fields (application/json): - `id` (string, required) User Check unique identifier. ## Response 400 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, required) Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers. - `title` (string) A short, human-readable title for the general error type; the title should not change for given types. - `detail` (string) A human-readable description of the specific error. - `instance` (string) This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response. - `request_id` (string) Correlation ID for the original request. ## Response 401 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, required) Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers. - `title` (string) A short, human-readable title for the general error type; the title should not change for given types. - `detail` (string) A human-readable description of the specific error. - `instance` (string) This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response. - `request_id` (string) Correlation ID for the original request. ## Response 403 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, required) Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers. - `title` (string) A short, human-readable title for the general error type; the title should not change for given types. - `detail` (string) A human-readable description of the specific error. - `instance` (string) This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response. - `request_id` (string) Correlation ID for the original request. ## Response 404 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, required) Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers. - `title` (string) A short, human-readable title for the general error type; the title should not change for given types. - `detail` (string) A human-readable description of the specific error. - `instance` (string) This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response. - `request_id` (string) Correlation ID for the original request. ## Response 406 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, required) Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers. - `title` (string) A short, human-readable title for the general error type; the title should not change for given types. - `detail` (string) A human-readable description of the specific error. - `instance` (string) This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response. - `request_id` (string) Correlation ID for the original request. ## Response 429 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, required) Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers. - `title` (string) A short, human-readable title for the general error type; the title should not change for given types. - `detail` (string) A human-readable description of the specific error. - `instance` (string) This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response. - `request_id` (string) Correlation ID for the original request. ## Response 500 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, required) Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers. - `title` (string) A short, human-readable title for the general error type; the title should not change for given types. - `detail` (string) A human-readable description of the specific error. - `instance` (string) This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response. - `request_id` (string) Correlation ID for the original request. ## Response 503 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, required) Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers. - `title` (string) A short, human-readable title for the general error type; the title should not change for given types. - `detail` (string) A human-readable description of the specific error. - `instance` (string) This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response. - `request_id` (string) Correlation ID for the original request. ## Response 504 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, required) Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers. - `title` (string) A short, human-readable title for the general error type; the title should not change for given types. - `detail` (string) A human-readable description of the specific error. - `instance` (string) This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response. - `request_id` (string) Correlation ID for the original request.