Core API
- Concepts
- Authentication
- Countries
- Users
- KYC
- 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
- Webhooks
- Capabilities
- Terms of Service
- Files
- Assets
- Accounts
- External Accounts
- Transactions
- Webhooks
Widgets API
- Payment
Get overview
Get the KYC overview of a user.
curl --request GET \
--url https://api.enterprise.sandbox.uphold.com/core/kyc \
--header 'Authorization: Bearer <token>'{
"summary": {
"reason": "none",
"status": "ok"
},
"processes": {
"profile": {
"status": "ok"
},
"address": {
"status": "ok"
},
"email": {
"status": "ok"
},
"phone": {
"status": "ok"
},
"identity": {
"status": "ok"
},
"proofOfAddress": {
"status": "ok"
},
"customerDueDiligence": {
"status": "ok"
},
"enhancedDueDiligence": {
"status": "ok"
},
"cryptoRiskAssessment": {
"status": "ok"
},
"selfCategorizationStatement": {
"status": "ok"
},
"screening": {
"status": "ok"
},
"risk": {
"status": "ok"
},
"taxDetails": {
"status": "ok"
}
}
}The KYC overview endpoint provides a summary of the KYC process for the user.
By default, only the status of each KYC process is included in the response.
If you need detailed information, you can use the detailed query parameter to specify the KYC processes you want more detail, which will bring
their input, output fields as well as hint if applicable.
Authorizations
OAuth 2.0 authentication.
Headers
The natural language and locale that the client prefers.
Query Parameters
Include detailed information about the specified KYC processes. Use this sparingly as its more expensive to retrieve.
profile, address, email, phone, identity, proofOfAddress, customerDueDiligence, enhancedDueDiligence, cryptoRiskAssessment, selfCategorizationStatement, taxDetails, screening, risk Response
The KYC overview object.
The KYC profile object.
Status of the KYC process.
ok, failed, running, pending, exempt The KYC address object.
Status of the KYC process.
ok, failed, running, pending, exempt Input of the KYC process.
The address information.
The country of the address.
The subdivision of the address.
The city of the address.
The first line of the address.
The second line of the address.
The postal code of the address.
The KYC email object.
Status of the KYC process.
ok, failed, running, pending, exempt Input of the KYC process.
The email address that was verified.
The KYC phone object.
Status of the KYC process.
ok, failed, running, pending, exempt Status of the KYC process.
ok, failed, running, pending, exempt Input of the KYC process.
The media that were collected during the process.
Output of the KYC process.
The provider used to verify the KYC process.
The identity document information.
The type of the document.
driving-license, id-card, passport, residence-permit, unsupported The number of the document.
The country of the document.
The expiration date of the document.
The person information.
The person's given name.
The date of birth.
The person's family name or surname.
The gender.
female, male The address information.
The date and time of the verification.
The reason associated with the verification.
data-mismatch, duplicate, fraud, missing-declared-information, underage Status of the KYC process.
ok, failed, running, pending, exempt Input of the KYC process.
The type of the proof of address.
electronic-verification, document-submission, from-identity Output of the KYC process.
The provider used to verify the KYC process.
The date and time of the verification.
The reason associated with the verification.
address-mismatch, name-mismatch Status of the KYC process.
ok, failed, running, pending, exempt Hints for the KYC process.
The type of the hint.
form The id of the 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.
Status of the KYC process.
ok, failed, running, pending, exempt Status of the KYC process.
ok, failed, running, pending, exempt Output of the KYC process.
The output result of the KYC process.
approved, none, rejected The cooldown state of the KYC process.
The date and time when the cooldown ends.
Hints for the KYC process.
The type of the hint.
form The id of the 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.
Status of the KYC process.
ok, failed, running, pending, exempt Output of the KYC process.
The output result of the KYC process.
approved, none, rejected The date and time when the KYC process expires.
Hints for the KYC process.
The type of the hint.
form The id of the 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.
Status of the KYC process.
ok, failed, running, pending, exempt Output of the KYC process.
The output result of the KYC process.
approved, none, rejected The date and time of the verification.
Hints for the KYC process.
The type of the hint.
form The id of the 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.
Status of the KYC process.
ok, failed, running, pending, exempt curl --request GET \
--url https://api.enterprise.sandbox.uphold.com/core/kyc \
--header 'Authorization: Bearer <token>'{
"summary": {
"reason": "none",
"status": "ok"
},
"processes": {
"profile": {
"status": "ok"
},
"address": {
"status": "ok"
},
"email": {
"status": "ok"
},
"phone": {
"status": "ok"
},
"identity": {
"status": "ok"
},
"proofOfAddress": {
"status": "ok"
},
"customerDueDiligence": {
"status": "ok"
},
"enhancedDueDiligence": {
"status": "ok"
},
"cryptoRiskAssessment": {
"status": "ok"
},
"selfCategorizationStatement": {
"status": "ok"
},
"screening": {
"status": "ok"
},
"risk": {
"status": "ok"
},
"taxDetails": {
"status": "ok"
}
}
}