Introduction

​

Key features and benefits

• Eliminate the need to read provider-specific payloads and manually map them to Uphold’s KYC model - the KYC Connector API ingests and normalizes provider data for you.
• Enable Uphold to continue relying on your existing KYC provider, even when you are not the authoritative party for certain processes. The KYC Connector API ingests KYC data on your behalf and uses it to run our compliance checks.
• Simplify your integration efforts by using a single API to interact with multiple KYC providers, rather than building and maintaining separate integrations for each provider.

​

Supported providers

Sumsub

A leading and comprehensive identity verification solution that focuses on compliance and user experience.

Veriff (soon)

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

Sumsub

A leading and comprehensive identity verification solution that focuses on compliance and user experience.

Veriff (soon)

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

​

Ingestions

​

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.

• Polling: Poll the endpoint that retrieves an ingestion by its ID.
• Webhooks: Subscribe to webhooks to be notified when an ingestion status changes.

​

Results

{
  "result": {
    "identity": {
      "status": "processing"
    }
  }
}

{
  "result": {
    "identity": {
      "status": "completed",
      "data": {
        "document": {
          "type": "passport",
          "number": "7700225VH",
          "country": "GB",
          "expiresAt": "2026-03-13"
        },
        "person": {
          "givenName": "John",
          "familyName": "Doe",
          "birthdate": "1987-01-01",
          "gender": "male"
        },
        "verifiedAt": "2020-01-01T00:00:00Z"
      },
      "files": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "category": "document",
          "context": "photo-document-front",
          "contentType": "image/png",
          "size": 204800,
          "providerDetails": {
            "fileId": "732150141"
          }
        }
      ]
    }
  }
}

{
  "result": {
    "identity": {
      "status": "failed",
      "error": {
        "code": "provider_data_not_available",
        "message": "Profile data not available in Sumsub applicant info",
        "hint": "Most likely the share token refers to an applicant without identity verification process."
      }
    }
  }
}

​

Important note on completed status

• 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.