Skip to main content
GET
/
core
/
kyc
Get overview
curl --request GET \
  --url https://api.enterprise.sandbox.uphold.com/core/kyc \
  --header 'Authorization: Bearer <token>'
{
  "summary": {
    "reason": "none",
    "status": "ok"
  },
  "processes": {
    "profile": {
      "code": "profile",
      "status": "ok"
    },
    "address": {
      "code": "address",
      "status": "ok"
    },
    "email": {
      "code": "email",
      "status": "ok"
    },
    "phone": {
      "code": "phone",
      "status": "ok"
    },
    "identity": {
      "code": "identity",
      "status": "ok",
      "type": "document-submission"
    },
    "proofOfAddress": {
      "code": "proof-of-address",
      "status": "ok",
      "type": "electronic-verification"
    },
    "customerDueDiligence": {
      "code": "customer-due-diligence",
      "status": "ok"
    },
    "enhancedDueDiligence": {
      "code": "enhanced-due-diligence",
      "status": "ok"
    },
    "cryptoRiskAssessment": {
      "code": "crypto-risk-assessment",
      "status": "ok"
    },
    "selfCategorizationStatement": {
      "code": "self-categorization-statement",
      "status": "ok"
    },
    "taxDetails": {
      "code": "tax-details",
      "status": "ok"
    },
    "screening": {
      "code": "screening",
      "status": "ok"
    },
    "risk": {
      "code": "risk",
      "status": "ok"
    }
  }
}
Get overview is the endpoint that provides a summary of the user’s KYC process. 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.
Getting the detailed KYC information is more expensive in terms of performance and should be used only when necessary.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication.

Headers

​
Accept-Language
string

The natural language and locale that the client prefers.

Query Parameters

​
detailed
enum<string>[]

Include detailed information about the specified KYC processes. Use this sparingly as its more expensive to retrieve.

Maximum array length: 20
Available options:
profile,
address,
email,
phone,
identity,
proofOfAddress,
customerDueDiligence,
enhancedDueDiligence,
cryptoRiskAssessment,
selfCategorizationStatement,
taxDetails,
screening,
risk

Response

KYC overview retrieved.

The KYC overview object.

​
summary
object
required
​
processes
object
required