Skip to main content
Version: Canary 🚧

What is CorePass Connector?

CorePass Connector is the gateway between your application and the CorePass identity ecosystem. It is a hosted service: you do not deploy or operate any infrastructure, and you do not need to hold a Core wallet or Core Token (CTN). You register your application in the CorePass developer dashboard and call the public API.

What you can build​

CapabilityWhat it doesWhere to start
CorePass LoginUsers sign in by scanning a QR code with the CorePass app. Standard OAuth 2.0 / OpenID Connect; you receive a JWT whose sub claim is the user's CoreID (their blockchain address).Login (OAuth 2.0 / OIDC)
KYC β€” personal identityOnce a user is logged in, request specific verified fields (name, date of birth, document number, address, email, …). The user approves on their phone and the data is delivered to your webhook.KYC overview
KYB β€” business identityLog in as a business, request verified company / director / UBO data as a signed attestation, and ask a business to sign a message or typed-data document.KYB overview

How it fits together​

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” OAuth 2.0 / OIDC β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” QR / deep link β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚ Your app β”‚ ────────────────────▢ β”‚ CorePass Connector β”‚ ◀────────────────▢ β”‚ CorePass app β”‚
β”‚ (frontend and β”‚ ◀──── JWT (CoreID) ── β”‚ auth.corepass.net β”‚ approve / sign β”‚ (user phone) β”‚
β”‚ backend) β”‚ β”‚ β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
β”‚ β”‚ ── API key: KYC/KYB β–Ά β”‚ β”‚
β”‚ β”‚ ◀── signed webhooks ─ β”‚ β”‚ ── settlement ──▢ Core Blockchain
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
  • Browser-facing: the OAuth 2.0 endpoints (/oauth2/auth, /oauth2/token, /userinfo, discovery and JWKS). The Connector serves the QR login page itself.
  • Server-to-server: the KYC (/api/v1/blockchain/*, /api/v2/kyc/*) and KYB (/api/v1/kyb/*) endpoints, authenticated with your API key. Never call these from a browser.
  • Webhooks: the Connector calls your HTTPS endpoints with status updates and delivered data.

Integration journey​

  1. Quickstart β€” the whole integration in one page.
  2. Dashboard setup β€” register your domain, create an OAuth client and an API key.
  3. Login β€” add "Login with CorePass" and obtain the user's CoreID.
  4. KYC and/or KYB β€” request verified data.
  5. API reference β€” every endpoint, header and response shape in one place.
  6. Environments & migration β€” hosts, and what changed if you used the former self-hosted Connector.
Previously self-hosted

CorePass Connector (previously "CorePass Hydra") used to be a bundle of services that you deployed yourself (PostgreSQL, NATS, Redis, a funded Core wallet, …). That model has been replaced by the hosted service described here. See Environments & migration for a mapping of old concepts to new ones.