API Reference — React Native

createVerifierSDK(config)

Creates and returns a VerifierSDK instance. Same configuration as the web SDK.

import { createVerifierSDK } from '@vecu/verifier-react-native-sdk';

const sdk = createVerifierSDK({
  stage: 'production',
  bearerToken: 'your-token',
});

Configuration

The SDK automatically resolves the correct endpoint for each stage. The apiBaseUrl property is available for local mock server testing only.

Components

VerificationView

Full verification flow component. Handles loading, QR display, polling, and all result states.

<VerificationView
  sdk={sdk}
  vin='1HGBH41JXMN109186'
  hostHandlesResults={true}
  onApproved={result => {
    /* VerificationApproved */
  }}
  onDenied={result => {
    /* VerificationDenied */
  }}
  onExpired={result => {
    /* VerificationExpired */
  }}
  onError={error => {
    /* VerifierError */
  }}
  style={{ flex: 1 }}
/>

When you use VerificationView, prefer these callback props as the app-facing integration boundary. Internally, the component listens to SDK status updates and invokes the callbacks when terminal states arrive.

Hooks

useVerifierSDK(config)

Creates an SDK instance tied to the component lifecycle. Automatically destroys on unmount.

import { useVerifierSDK } from '@vecu/verifier-react-native-sdk';

const sdk = useVerifierSDK({
  stage: 'production',
  bearerToken: token,
});

Core SDK Methods

createPresentationRequest(vin, options?)

const result = await sdk.createPresentationRequest('1HGBH41JXMN109186', {
  proximity: { thresholdMiles: 5.0 },
});
if (result.ok) {
  const { request_id, qr_content, expires_at } = result.data;
}

startPolling()

Starts polling for verification status. Stops automatically on terminal states.

Returns: () => void — cleanup function to stop polling.

stopPolling()

Manually stop polling.

getStatus() / getRequest()

Get current verification status or full request state.

destroy()

Clean up all resources.

Verification Status Types

All statuses share a common shape with requestId, createdAt?, and expiresAt?:

// Pending — waiting for driver to scan
{ status: 'pending', requestId: string, createdAt?: string, expiresAt?: string }

// Approved — credential verified, OK to release vehicle
{
  status: 'approved',
  requestId: string,
  createdAt?: string,
  expiresAt?: string,
  verifiedClaims?: { vin: string, originLocation?: string, destinationLocation?: string },
  proximityCheck?: { status: 'pass' | 'fail' | 'unchecked', distanceMiles, thresholdMiles, ... },
}

// Denied — DO NOT release vehicle
{ status: 'denied', requestId: string, createdAt?: string, expiresAt?: string, error?: string }

// Expired — session timed out
{ status: 'expired', requestId: string, createdAt?: string, expiresAt?: string }

Type guards: isApproved(status), isDenied(status), isTerminalStatus(status)

Proximity Types

ProximityConfig

Device GPS coordinates are retrieved automatically via platform location services. If location permission is not granted, the proximity check result will be unchecked.

interface ProximityConfig {
  thresholdMiles: number; // Max allowed distance from origin (miles)
}

ProximityCheck

Returned on VerificationApproved.proximityCheck:

Error Types

All errors include code, message, and timestamp. Use isVerifierError() type guard.

Error Factory Functions

Helper functions for creating typed errors:

import {
  createNetworkError,
  createApiError,
  createValidationError,
  createTimeoutError,
  createSessionError,
  isVerifierError,
} from '@vecu/verifier-react-native-sdk';