Skip to main content

Member Access

Learn how to create and manage access URLs for your business members — allowing them to use Brighty services through a web interface or an embedded iframe.

Overview

Every business member can be given an access URL that opens a personal Brighty web interface. Through this interface, members can view their account, manage their card, see crypto deposit addresses, and confirm 3DS transactions. Access URLs are time-limited and can be deactivated at any time.

This guide covers creating access URLs, embedding them in your application, and managing their lifecycle.

Prerequisites

Before managing member access, ensure you have:

  • A verified business account on Brighty
  • Valid API token with member management permissions
  • Business owner or admin role
  • A member ID (from Member Management or External Members)

Access Management Workflow

Step 1: Create Access URL

Generate an access URL for a member by providing their member ID:

curl -X POST https://api.brighty.codes/business/v1/members/f8a1e626-78cc-4ed7-bba6-8b47a842dc87/access \
-H "Authorization: Bearer ${BRIGHTY_API_TOKEN}"

Response:

{
"access": {
"url": "https://ext.brighty.codes#memberToken=eyJhbGciOiJSUz...",
"validUntil": "2026-03-16T15:36:25.886Z"
}
}

The response contains:

  • access.url — the access URL for the member
  • access.validUntil — the expiration timestamp of the URL
note

Creating a new access URL automatically invalidates any previously active URL for the same member.

Step 2: Deactivate Access URL

To revoke a member's access before the URL expires:

curl -X DELETE https://api.brighty.codes/business/v1/members/f8a1e626-78cc-4ed7-bba6-8b47a842dc87/access \
-H "Authorization: Bearer ${BRIGHTY_API_TOKEN}"

This endpoint returns 204 No Content on success. After deactivation, the member will no longer be able to use the previously issued URL. You can create a new access URL at any time using Step 1.

Embedding in iframe

The access URL can be embedded directly in your application using an iframe, providing a seamless experience for your users:

<iframe
src="https://ext.brighty.codes#memberToken=eyJhbGciOiJSUz..."
width="100%"
height="700"
frameborder="0"
allow="clipboard-write"
></iframe>

Through the embedded interface, the member can:

  • View their account balance
  • See their crypto deposit addresses (if created)
  • Manage their card (if issued)
  • Confirm 3DS transactions

Access URL Lifecycle

Access URLs are designed to be temporary and renewable:

  • Validity period — each URL has a validUntil timestamp. After this time, the URL stops working.
  • Reissuing — create a new access URL at any time using Step 1. This automatically invalidates the previous URL.
  • Deactivation — use Step 2 to immediately revoke access without waiting for expiration.
  • One active URL per member — a member can only have one active access URL at a time.
tip

Monitor the validUntil field and proactively reissue access URLs before they expire to ensure uninterrupted access for your members.

Access URL Format

The access URL format depends on the environment:

EnvironmentURL Format
Sandboxhttps://ext.brighty.codes#memberToken=<token>
Productionhttps://ext.brighty.app#memberToken=<token>

The token in the URL fragment (#memberToken=...) is a JWT that identifies the member and grants access to their personal interface.