Skip to main content
The KYC Connector API is an API designed to connect third-party KYC providers with Uphold’s platform, without you having to build and maintain bespoke integrations. It functions as an ingestion layer between mainstream KYC providers and Uphold’s platform KYC processes, such as profile, address, identity and proofOfAddress.

​
Key features and benefits

  • Compatible with multiple KYC providers, so you can connect whichever provider you use without any custom integration work.
  • The KYC Connector API ingests and normalizes provider data for you.
  • Enable your platform to continue relying on your existing KYC provider.

​
Supported providers

sumsub-logo-for-white

Sumsub

A leading and comprehensive verification solution that focuses on compliance and user experience.
veriff-logo

Veriff

An AI-driven, scalable verification that helps businesses meet compliance requirements.
sumsub-logo-for-black

Sumsub

A leading and comprehensive verification solution that focuses on compliance and user experience.
veriff-logo

Veriff

An AI-driven, scalable verification that helps businesses meet compliance requirements.

​
Ingestions

KYC Connector is a workflow-based ingestion system. An ingestion pulls KYC data from an existing user verification on the provider side and submits it to Uphold’s platform on their behalf. The verification must already be approved before you can create one. When creating an ingestion, you provide a reference to the user’s verification and specify which KYC processes to ingest — the API handles fetching and normalizing the provider data for you.

​
Statuses

The ingestion workflow follows these statuses:
  • Queued: When you create an ingestion, it starts in the queued state.
  • Running: The ingestion will be quickly picked up by a worker, which changes its status to running and starts processing it. During this phase, the worker interacts with the provider’s API to retrieve KYC data and files for the specified processes.
  • Finished: Once the ingestion processing comes to an end, its status changes to finished.
You can track ingestions in two ways:
  • Polling: Poll the endpoint that retrieves an ingestion by its ID.
  • Webhooks: Subscribe to webhooks to be notified when an ingestion status changes.

​
Results

Under the result field, you can find the outcome of the ingestion of each KYC process. For example, if you created an ingestion to ingest both identity and proofOfAddress processes, the result will contain the outcome of both processes. Each process will have its own status, which can be processing, completed, or failed as well as extracted data and an error if the ingestion for that process failed. Below are examples of possible results for an identity ingestion: 
{
  "result": {
    "identity": {
      "status": "processing"
    }
  }
}

​
Important note on completed status

When a process status is marked as completed, it means that the data has been extracted and submitted to Uphold’s platform. However, it does not necessarily mean that the KYC process is “ok”. You should always check the actual KYC process status after ingestion using the Get KYC Overview endpoint. For instance:
  • The profile process ingestion can be completed but the actual profile KYC process status might still be pending in case there are still fields to be submitted.
  • The identity process ingestion can be completed but the actual identity KYC process status might be failed in situations like a duplicate identity conflict with another user or if the user is underage.
Simply put, completed indicates successful data extraction and submission to the platform, not a successful KYC verification result.