SecureAddress Bridge SDK

The SecureAddress Bridge JavaScript SDK provides an easy way to integrate with SecureAddress Bridge to securely access verified physical addresses with enhanced blockchain support and blind shipping capabilities.

Installation

npm install secureaddress-bridge-sdk

Quick Start

import { SecureAddressBridge } from 'secureaddress-bridge-sdk';

// Initialize with your app credentials
const client = new SecureAddressBridge({
  appId: 'YOUR_APP_ID',
  redirectUri: 'https://your-app.com/callback'
});

// Authorize a user to share their address
client.authorize({
  scope: ['street', 'city', 'state', 'postal_code', 'country'],
  expiryDays: 30
});

// In your callback handler
async function handleCallback() {
  const result = await client.handleCallback();
  if (result.success) {
    // Get user's address
    const addressData = await client.getAddress({
      includeVerificationInfo: true
    });
    console.log(addressData);
  }
}

React Integration

import { useSecureAddress } from 'secureaddress-bridge-sdk';

function AddressComponent() {
  const {
    address,
    isLoading,
    error,
    requestAccess,
    hasValidPermission
  } = useSecureAddress({
    appId: 'YOUR_APP_ID',
    redirectUri: 'https://your-app.com/callback',
    scope: ['street', 'city', 'state']
  });

  if (isLoading) return <div>Loading...</div>;
  if (error) return <div>Error: {error.message}</div>;
  
  if (!hasValidPermission) {
    return (
      <button onClick={requestAccess}>
        Share your address
      </button>
    );
  }
  
  return (
    <div>
      <h2>Your Address</h2>
      <p>{address?.street}</p>
      <p>{address?.city}, {address?.state} {address?.postal_code}</p>
      <p>{address?.country}</p>
    </div>
  );
}

Documentation

For complete documentation, visit https://docs.secureaddress.bridge

License

This project is licensed under the MIT License - see the LICENSE file for details.