# User checks events

Notifies subscribers of user check lifecycle events.
Triggered when a check is created, passed, or failed for a user.
See the Conducting regulatory checks guide ([TOL](https://docs.upvest.co/products/tol/guides/users/users_onboarding_checks) / [BYOL](https://docs.upvest.co/products/byol/guides/users/users_onboarding_checks)) for check types.

Endpoint: POST User checks events
Version: 1.144.0

## Request fields (application/json):

  - `id` (string, required)
    Event unique identifier

  - `created_at` (string, required)
    Date and time when the event was created. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)

  - `type` (string, required)
    Event type.
* USER_CHECK.CREATED — a check has been created for the user.
* USER_CHECK.PASSED — the check has passed.
* USER_CHECK.FAILED — the check has failed.
    Enum: "USER_CHECK.CREATED", "USER_CHECK.PASSED", "USER_CHECK.FAILED"

  - `object` (any, required)
    A check conducted for a user: KYC, proof of residence, instrument fit, compliance, guardian, or self-assessment.

  - `object.id` (string, required)
    User Check unique identifier.

  - `object.user_id` (string, required)
    Unique identifier of the user, as a UUID.

  - `object.type` (string, required)
    The type of check must be “KYC”.

  - `object.check_confirmed_at` (string, required)
    Completion date and time of the KYC check. Must not be older than 24 months.

  - `object.data_download_link` (string, required)
    Download URL for the KYC evidence file. The file size must not exceed 250 MB.

  - `object.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"

  - `object.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

  - `object.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

  - `object.status` (string, required)
    Final status of the KYC check.
* IN_PROGRESS - KYC check is in progress
* PASSED - KYC check passed
* FAILED - KYC check failed
    Enum: "IN_PROGRESS", "PASSED", "FAILED"

  - `object.provider` (string, required)
    Provider that was used to perform the KYC check.

  - `object.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"

  - `object.confirmed_address` (object)
    Address. Must not be a P.O. box or c/o address.

  - `object.confirmed_address.address_line1` (string, required)
    First address line of the address.

  - `object.confirmed_address.address_line2` (string)
    Second address line of the address.

  - `object.confirmed_address.postcode` (string, required)
    Postal code (postcode, PIN or ZIP code)

  - `object.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"

  - `object.confirmed_address.state` (string)
    State, province, county. [ISO 3166 alpha-2 Codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).

  - `object.confirmed_address.city` (string, required)

  - `object.kyc_update` (boolean)
    Marks this check as a KYC refresh/update as opposed to an initial record.

  - `object.type` (string, required)
    The type of check must be POR.

  - `object.check_confirmed_at` (string, required)
    Completion date and time of the PoR check.

  - `object.issuance_date` (string, required)
    Issuance date in YYYY-MM-DD format.

  - `object.data_download_link` (string, required)
    Download URL for the PoR evidence file. The file size must not exceed 250 MB.

  - `object.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 -
* PASSPORT -
    Enum: "UTILITY_BILL", "TELEPHONE_BILL", "INTERNET_BILL", "BANK_STATEMENT", "REGISTRATION_CERT", "RESIDENCE_PERMIT", "ID_CARD", "PASSPORT"

  - `object.status` (string, required)
    Final status of the PoR check.
* IN_PROGRESS -
* PASSED -
* FAILED -
    Enum: "IN_PROGRESS", "PASSED", "FAILED"

  - `object.type` (string, required)
    The type of check must be INSTRUMENT_FIT.

  - `object.check_confirmed_at` (string, required)
    Completion date and time of the instrument fit check.

  - `object.status` (string, 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
    Enum: "IN_PROGRESS", "PASSED", "FAILED"

  - `object.instrument_suitability` (object, required)
    Outcome of the user's instrument suitability assessment.

  - `object.instrument_suitability.suitability` (boolean, required)
    Did the user go through a suitability assessment and the outcome indicated suitability.

  - `object.type` (string, required)
    The type of check must be COMPLIANCE.

  - `object.status` (string)
    Final status of the COMPLIANCE check.
* IN_PROGRESS - Compliance check is in progress
* PASSED - Compliance check passed
* FAILED - Compliance check failed
    Enum: "IN_PROGRESS", "PASSED", "FAILED"

  - `object.check_confirmed_at` (string, required)
    Completion date and time of the COMPLIANCE check.

  - `object.type` (string, required)
    The type of check must be “GUARDIAN“.

  - `object.role_id` (string, required)
    Unique identifier for the role that this guardian check is associated with.

  - `object.document_type` (string, required)
    The type of document used in the Guardian check.
* BIRTH_CERTIFICATE - Birth certificate proving guardian relationship
    Enum: "BIRTH_CERTIFICATE"

  - `object.data_download_link` (string, required)
    Download URL for the guardian evidence file. The file size must not exceed 250 MB.

  - `object.status` (string, required)
    Final status of the Guardian check.
* IN_PROGRESS - Guardian check is in progress
* PASSED - Guardian check passed
* FAILED - Guardian check failed
    Enum: "IN_PROGRESS", "PASSED", "FAILED"

  - `object.type` (string, required)
    The type of check must be "US_WITHHOLDING_TAX_STATUS".

  - `object.check_confirmed_at` (string, required)
    The date and time when the US withholding tax status was confirmed.

  - `object.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.

  - `object.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"

  - `object.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"

  - `object.valid_from` (string, required)
    The date from which the US withholding tax status is valid, in YYYY-MM-DD format.

  - `object.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.

  - `object.status` (string, required)
    Final status of the US Withholding Tax Status check.
* IN_PROGRESS - US Withholding Tax Status check is in progress
* PASSED - US Withholding Tax Status check passed
* FAILED - US Withholding Tax Status check failed

A documented status ("KYC", "W8-BEN" or "W9") is corroborated against the user's tax residency: it fails when the declared `person_type` contradicts the tax residency Upvest holds for the user, or when the user has no active tax residency on record. An "UNDOCUMENTED" status is recorded as declared and is not corroborated against tax residency.
    Enum: "IN_PROGRESS", "PASSED", "FAILED"

  - `webhook_id` (string, required)
    Webhook unique identifier.