Upvest · Schema

UserCheck

A compliance or verification check on a user.

Banking InfrastructureFintechInvestmentsSecuritiesFractional InvestingCustodyWealth Management

Properties

Name	Type	Description
id	string	The unique identifier of the check.
type	string	The type of check performed.
status	string	The current status of the check.
created_at	string	When the check was created.
completed_at	string	When the check was completed.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/upvest/refs/heads/main/json-schema/investment-api-user-check-schema.json",
  "title": "UserCheck",
  "description": "A compliance or verification check on a user.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "The unique identifier of the check.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "type": {
      "type": "string",
      "description": "The type of check performed.",
      "example": "standard"
    },
    "status": {
      "type": "string",
      "enum": [
        "PENDING",
        "PASSED",
        "FAILED"
      ],
      "description": "The current status of the check.",
      "example": "PENDING"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the check was created.",
      "example": "2025-03-15T14:30:00Z"
    },
    "completed_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the check was completed.",
      "example": "2025-03-15T14:30:00Z"
    }
  }
}