PATCH
/
core
/
kyc
/
processes
/
crypto-risk-assessment
curl --request PATCH \
  --url https://api.enterprise.sandbox.uphold.com/core/kyc/processes/crypto-risk-assessment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "input": {
    "formId": "7a0f4229-e3de-4dfd-8f91-9b1308b2dc33",
    "answers": {
      "financial-information": {
        "annual-income-range": "20000-30000"
      }
    }
  }
}'
{
  "cryptoRiskAssessment": {
    "status": "pending",
    "input": {
      "formId": "7a0f4229-e3de-4dfd-8f91-9b1308b2dc33",
      "answers": {
        "financial-information": {
          "annual-income-range": "20000-30000"
        }
      }
    },
    "hint": {
      "type": "form",
      "formId": "7a0f4229-e3de-4dfd-8f91-9b1308b2dc33",
      "schema": {
        "type": "object",
        "properties": {
          "financial-information": {
            "type": "object",
            "title": "Level of income",
            "description": "Please select your income level.",
            "properties": {
              "annual-income-range": {
                "type": "string",
                "oneOf": [
                  {
                    "const": "0-20000",
                    "title": "< $ 20,000"
                  },
                  {
                    "const": "20000-30000",
                    "title": "$ 20,000 - $ 30,000"
                  },
                  {
                    "const": "30000-40000",
                    "title": "$ 30,000 - $ 40,000"
                  },
                  {
                    "const": "40000-60000",
                    "title": "$ 40,000 - $ 60,000"
                  },
                  {
                    "const": "60000-80000",
                    "title": "$ 60,000 - $ 80,000"
                  },
                  {
                    "const": "80000-130000",
                    "title": "$ 80,000 - $ 130,000"
                  },
                  {
                    "const": "130000-210000",
                    "title": "$ 130,000 - $ 210,000"
                  },
                  {
                    "const": "210000-or-more",
                    "title": "$ 210,000 or more"
                  }
                ]
              }
            },
            "required": [
              "annual-income-range"
            ]
          },
          "attitude-towards-risk": {
            "type": "object",
            "title": "Attitude to risk",
            "description": "I am okay with the risk of my crypto investments having significant value fluctuations.",
            "properties": {
              "willingness-to-fluctuations": {
                "type": "string",
                "oneOf": [
                  {
                    "const": "strongly_agree",
                    "title": "Strongly agree"
                  },
                  {
                    "const": "agree",
                    "title": "Agree"
                  },
                  {
                    "const": "neither_agree_or_disagree",
                    "title": "Neither agree nor disagree"
                  },
                  {
                    "const": "disagree",
                    "title": "Disagree"
                  },
                  {
                    "const": "strongly_disagree",
                    "title": "Strongly disagree"
                  }
                ]
              }
            },
            "required": [
              "willingness-to-fluctuations"
            ]
          }
        }
      },
      "uiSchema": {
        "type": "Categorization",
        "elements": [
          {
            "type": "Category",
            "label": "Level of income",
            "elements": [
              {
                "type": "Control",
                "scope": "#/properties/financial-information/properties/annual-income-range"
              }
            ]
          },
          {
            "type": "Category",
            "label": "Attitude to risk",
            "elements": [
              {
                "type": "Control",
                "scope": "#/properties/attitude-towards-risk/properties/willingness-to-fluctuations"
              }
            ]
          }
        ]
      }
    }
  }
}

The crypto-risk-assessment is a form based KYC process composed of questions used to determine how knowledgeable the user is about crypto and its associated risks. This KYC process status will be exempt for all users residing outside of GB.

When calling GET /core/kyc?detailed=cryptoRiskAssessment, 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 crypto risk assessment process updated.
​
cryptoRiskAssessment
object
required