Core API
- Concepts
- Introduction
- GETGet overview
- PATCHUpdate email
- PATCHUpdate phone
- PATCHUpdate profile
- PATCHUpdate address
- PATCHUpdate identity
- PATCHUpdate proof of address
- PATCHUpdate customer due diligence
- PATCHUpdate enhanced due diligence
- PATCHUpdate crypto risk assessment
- PATCHUpdate self-categorization statement
- PATCHUpdate tax details
Topper API
Widgets API
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": {
"answers": {},
"formId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"output": {
"result": "approved",
"attempts": {
"used": 1,
"maximum": 30
},
"expiresAt": "2023-11-07T05:31:56Z",
"verifiedAt": "2023-11-07T05:31:56Z"
}
}
'{
"selfCategorizationStatement": {
"status": "ok",
"input": {
"answers": {},
"formId": "<string>"
},
"output": {
"result": "approved",
"attempts": {
"used": 123,
"maximum": 123
},
"offboard": {
"endsAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z"
},
"expiresAt": "2023-11-07T05:31:56Z",
"verifiedAt": "2023-11-07T05:31:56Z"
},
"hint": {
"type": "form",
"schema": {},
"uiSchema": {},
"formId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}Update self-categorization statement
Update the self-categorization statement process for a user.
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": {
"answers": {},
"formId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"output": {
"result": "approved",
"attempts": {
"used": 1,
"maximum": 30
},
"expiresAt": "2023-11-07T05:31:56Z",
"verifiedAt": "2023-11-07T05:31:56Z"
}
}
'{
"selfCategorizationStatement": {
"status": "ok",
"input": {
"answers": {},
"formId": "<string>"
},
"output": {
"result": "approved",
"attempts": {
"used": 123,
"maximum": 123
},
"offboard": {
"endsAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z"
},
"expiresAt": "2023-11-07T05:31:56Z",
"verifiedAt": "2023-11-07T05:31:56Z"
},
"hint": {
"type": "form",
"schema": {},
"uiSchema": {},
"formId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}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.
For more information about forms, refer to the form-based processes section.Authorizations
OAuth 2.0 authentication.
Headers
The natural language and locale that the client prefers.
Body
Input of the KYC process.
Show child attributes
Show child attributes
The answers property follows the JSON Forms specification for data objects and has two key behaviors:
- Partial or Complete Answers Submission:
- It accepts the answers to the questions of the current step (identified by UI Schema 'Category'). This allows the submission of the responses incrementally, either answering all questions in the current step or just a subset of them.
- Form Reset by Answering Previous Questions:
- It also allows for a form reset by accepting one or more answers from a previous step (identified by UI Schema 'Category'). This enables the modification of previous answers, ensuring that the form is flexible and can handle dynamic user interactions.
The KYC process starts its evaluation once the last question has been answered, ensuring that all necessary information has been provided before proceeding with the assessment.
The form identifier returned in the formId property of the KYC process hint. Include this value when you need to persist or resume the current form state over an extended period (for example, across user sessions or long-running saves).
Output of the KYC process.
Show child attributes
Show child attributes
The result of the verification.
approved, rejected The date and time when the verification expires.
The date and time of the verification.
Response
KYC self-categorization statement process updated.
Show child attributes
Show child attributes
Status of the KYC process.
ok, failed, running, pending, exempt Output of the KYC process.
Show child attributes
Show child attributes
The result of the verification.
approved, rejected The offboarding state of the verification.
The date and time when the verification expires.
The date and time of the verification.
Hints for the KYC process.
Show child attributes
Show child attributes
The type of the hint.
form The definition of the structure and validation rules for this KYC process form.
It follows the JSON Schema specification with the power of JSON Forms.
The schema is iterative, meaning that new questions and properties can be added dynamically as the KYC process evolves. This allows for a flexible and adaptive form structure that can accommodate changes and new requirements over time.
The uiSchema property defines the general layout and presentation of the form by means of different UI schema elements.
It follows the JSON Forms specification and is used to customize the appearance and behavior of the form fields.
The uiSchema includes the following elements:
Layouts: Used to structure the form layout. It includes properties liketypeto define the layout type (e.g.,Categorization) andelementsto define the child elements.Controls: Used to define the form controls. It includes properties likescopeto point to the corresponding schema property andlabelto define the control's label.Rules: Used to define conditional visibility rules for form controls. It includes properties likeeffectto define the rule effect (e.g.,SHOW) andconditionto define the rule condition.
The uiSchema is iterative, meaning that new controls and layout elements can be added dynamically as the KYC process evolves. This allows for a flexible and dynamic form layout, enhancing the user experience by providing a structured and intuitive form design that can adapt to new requirements and changes over time.
The id of the form.