PATCH
/
core
/
kyc
/
processes
/
self-categorization-statement
curl --request PATCH \
  --url https://api.enterprise.sandbox.uphold.com/core/kyc/processes/self-categorization-statement \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "input": {
    "formId": "ac33651f-f2d3-47c4-8e8d-06fb87361f5c",
    "answers": {
      "investor": {
        "type": "restricted_investor"
      }
    }
  }
}'
{
  "selfCategorizationStatement": {
    "status": "pending",
    "input": {
      "formId": "ac33651f-f2d3-47c4-8e8d-06fb87361f5c",
      "answers": {
        "investor": {
          "type": "restricted_investor"
        }
      }
    },
    "hint": {
      "type": "form",
      "formId": "ac33651f-f2d3-47c4-8e8d-06fb87361f5c",
      "schema": {
        "type": "object",
        "properties": {
          "investor": {
            "type": "object",
            "title": "Which type of investor are you?",
            "description": "The FCA divides investors into 3 types. Choose the best fit for you.",
            "properties": {
              "type": {
                "type": "string",
                "oneOf": [
                  {
                    "const": "restricted_investor",
                    "title": "Everyday investor"
                  },
                  {
                    "const": "high_net_worth_investor",
                    "title": "High-Net-Worth Investor"
                  },
                  {
                    "const": "sophisticated_investor",
                    "title": "Certified Sophisticated Investor"
                  },
                  {
                    "const": "none_of_above",
                    "title": "None of the above"
                  }
                ]
              }
            },
            "required": [
              "type"
            ]
          },
          "investor-profile": {
            "type": "object",
            "title": "Everyday Investor",
            "description": "Please confirm whether you qualify as a Everyday Investor.",
            "properties": {
              "invested-less-than-10-percent": {
                "type": "string",
                "oneOf": [
                  {
                    "const": "yes",
                    "title": "Yes, I have invested less than 10% of my net assets"
                  },
                  {
                    "const": "no",
                    "title": "No, I have invested more than 10% of my net assets"
                  }
                ]
              },
              "invest-less-than-10-percent": {
                "description": "In the next 12 months do you intend to limit your investment in high-risk investments to less than 10% of your net assets?",
                "type": "string",
                "oneOf": [
                  {
                    "const": "yes",
                    "title": "Yes, I intend to invest less than 10% of my net assets"
                  },
                  {
                    "const": "no",
                    "title": "No, I intend to invest more than 10% of my net assets"
                  }
                ]
              },
              "investor-type-confirmation": {
                "title": "I accept that being a Everyday Investor will expose me to promotions for investment where there is a significant risk of losing all the money I invest.",
                "type": "string",
                "oneOf": [
                  {
                    "const": "yes",
                    "title": "Yes"
                  },
                  {
                    "const": "no",
                    "title": "No"
                  }
                ]
              }
            },
            "required": [
              "invested-less-than-10-percent",
              "invest-less-than-10-percent",
              "investor-type-confirmation"
            ],
            "allOf": [
              {
                "if": {
                  "properties": {
                    "invested-less-than-10-percent": {
                      "const": "yes"
                    }
                  },
                  "required": [
                    "invested-less-than-10-percent"
                  ]
                },
                "then": {
                  "properties": {
                    "invested-percentage": {
                      "type": "number",
                      "minimum": 0,
                      "maximum": 100
                    }
                  },
                  "required": [
                    "invested-percentage"
                  ]
                }
              },
              {
                "if": {
                  "properties": {
                    "invest-less-than-10-percent": {
                      "const": "yes"
                    }
                  },
                  "required": [
                    "invest-less-than-10-percent"
                  ]
                },
                "then": {
                  "properties": {
                    "invest-percentage": {
                      "type": "number",
                      "minimum": 0,
                      "maximum": 100
                    }
                  },
                  "required": [
                    "invest-percentage"
                  ]
                }
              }
            ]
          }
        }
      },
      "uiSchema": {
        "type": "Categorization",
        "elements": [
          {
            "type": "Category",
            "label": "Which type of investor are you?",
            "elements": [
              {
                "type": "Control",
                "scope": "#/properties/investor/properties/type"
              }
            ]
          },
          {
            "type": "Category",
            "label": "Everyday Investor",
            "elements": [
              {
                "type": "Control",
                "scope": "#/properties/investor-profile/properties/invested-less-than-10-percent"
              },
              {
                "type": "Control",
                "scope": "#/properties/investor-profile/properties/invested-percentage",
                "rule": {
                  "effect": "SHOW",
                  "condition": {
                    "scope": "#/properties/investor-profile/properties/invested-less-than-10-percent",
                    "schema": {
                      "const": "yes"
                    }
                  }
                }
              },
              {
                "type": "Control",
                "scope": "#/properties/investor-profile/properties/invest-less-than-10-percent"
              },
              {
                "type": "Control",
                "scope": "#/properties/investor-profile/properties/invest-percentage",
                "rule": {
                  "effect": "SHOW",
                  "condition": {
                    "scope": "#/properties/investor-profile/properties/invest-less-than-10-percent",
                    "schema": {
                      "const": "yes"
                    }
                  }
                }
              },
              {
                "type": "Control",
                "scope": "#/properties/investor-profile/properties/investor-type-confirmation"
              }
            ]
          }
        ]
      }
    }
  }
}

The self-categorization-assessment is a form based KYC process composed of questions used to determine the user’s investor profile, including risk level and investment preferences. This KYC process status will be exempt for all users residing outside of GB.

When calling GET /core/kyc?detailed=selfCategorizationStatement, you will get a hint property which includes a JSON form schema and UI schema. The hint property will also be available in responses of this endpoint, in case there are still questions to be answered.

Please read more about forms in the Introduction page.

Authorizations

Authorization
string
header
required

OAuth 2.0 authentication.

Headers

Accept-Language
string

The natural language and locale that the client prefers.

Body

application/json
input
object
required

Input of the KYC process.

output
object

Output of the KYC process.

Response

200
application/json
KYC self-categorization statement process updated.
selfCategorizationStatement
object
required