Skip to main content

Qverity

Developer documentation

Integrate Qverity badges, automate evidence collection, and keep your trust tooling in sync with our API guides and SDKs.

Quick start

Request sandbox credentials from the trust team, install the SDK, and call the `/v1/scopes` endpoint to retrieve the verification level associated with your test profile. Use the badge component helpers to display the badge in your app and listen for status changes through webhook subscriptions.

Badge components

Render badges using our React component or the design tokens provided in Figma. Include the badge ID in your API calls so customers can verify the badge and review the evidence behind each scope check.

Webhook events

Subscribe to `badge.updated`, `scope.expiring`, and `dispute.opened` events to automate customer comms, pause risky listings, or request additional evidence. Qverity each payload with the signing secret provided in your dashboard.

Nigeria compliance adapters

The Qverity SDK exposes helpers for CAC company search, FIRS TIN confirmation, NIN/BVN validation, and sanctions screening. Mock adapters ship with the repo (see lib/verify/providers) so you can develop without production credentials. Swap these mocks for live integrations by implementing the same interface and injecting your API keys via environment variables.

When rollout begins, enable caching and audit logging around each provider call to respect rate limits and meet regulatory record-keeping requirements.

Badge sharing

Customers can copy an iframe embed, direct link, or PNG download from the badge detail page. Reuse the QverityBadgecomponent to render a responsive badge in your dashboard or marketing updates. Each badge exposes share.embedHtml andshare.downloadUrl fields so you can roll your own tooling.

API reference

REST endpoints, authentication, and schema definitions for all Qverity services.

Open resource →

Postman collection

Importable collection with sample requests that mirror production behaviour.

Open resource →

SDK downloads

TypeScript, Python, and Kotlin SDKs with helpers for badge rendering and webhook validation.

Open resource →