Member Management

Learn how to manage your business members using the Brighty B2B API — list existing members, add new ones, update their legal information, and remove them when needed.

Overview

Members are the people associated with your business on Brighty. Each member has a role that defines their permissions, and optionally legal data required for card issuance. This guide covers the complete member lifecycle from adding members to preparing them for card issuance.

Prerequisites

Before managing members, ensure you have:

• A verified business account on Brighty
• Valid API token with member management permissions
• Business owner or admin role

Member Management Workflow

Step 1: List Members

Retrieve all members of your business:

curl -X GET https://api.brighty.codes/business/v1/members \
  -H "Authorization: Bearer ${BRIGHTY_API_TOKEN}"

Response:

{
  "members": [
    {
      "customer": {
        "id": "822089d0-9a90-45fe-98ef-8a6a201ffc81",
        "username": "@john",
        "name": "John Doe",
        "picture": null
      },
      "membership": {
        "memberId": "822089d0-9a90-45fe-98ef-8a6a201ffc81",
        "role": "OWNER",
        "state": "ACTIVE"
      },
      "contact": {
        "email": "john@example.com",
        "phone": null
      },
      "legalData": {
        "name": {
          "firstName": "John",
          "lastName": "Doe"
        },
        "birthInfo": {
          "birthDate": "1990-01-15",
          "birthPlace": {
            "city": "New York",
            "country": "US"
          }
        },
        "nationality": "US"
      }
    },
    {
      "customer": {
        "id": "a1b2c3d4-5678-9012-abcd-ef1234567890",
        "username": "@jane",
        "name": "Jane Smith",
        "picture": null
      },
      "membership": {
        "memberId": "a1b2c3d4-5678-9012-abcd-ef1234567890",
        "role": "PAYER",
        "state": "ACTIVE"
      },
      "contact": {
        "email": "jane@example.com",
        "phone": null
      },
      "legalData": {
        "name": null,
        "birthInfo": null,
        "nationality": null
      }
    }
  ]
}

Each member object contains:

• customer — member identity (id, username, name, picture)
• membership — memberId, role, and state within the business
• contact — email and phone
• legalData — legal name, birth info, and nationality (required for card issuance)

Member Roles

Role	Description
OWNER	Full access to all business operations. Can manage members and settings.
ADMIN	Can manage members, cards, and accounts. Cannot change business settings.
PAYER	Can make payments and transfers using business accounts.
MEMBER	Basic access to the business. Can view their own cards and transactions.
VIEWER	Read-only access. Can view business information but cannot make operations.

Step 2: Add Members

Invite new members to your business by providing their email and role:

curl -X POST https://api.brighty.codes/business/v1/members \
  -H "Authorization: Bearer ${BRIGHTY_API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "members": [
      {
        "email": "alice@example.com",
        "role": "PAYER"
      },
      {
        "email": "bob@example.com",
        "role": "MEMBER",
        "legalName": {
          "firstName": "Bob",
          "lastName": "Smith"
        },
        "birthInfo": {
          "birthDate": "1985-03-20",
          "birthPlace": {
            "city": "Berlin",
            "country": "DE"
          }
        },
        "nationality": "DE"
      }
    ]
  }'

Response:

[
  {
    "memberId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "role": "PAYER",
    "state": "ACTIVE"
  },
  {
    "memberId": "ffffffff-1111-2222-3333-444444444444",
    "role": "MEMBER",
    "state": "ACTIVE"
  }
]

The response returns an array of membership objects confirming the created members. You can add multiple members in a single request. Each member requires an email and role. Legal data fields (legalName, birthInfo, nationality) are optional at this stage but required before issuing a card.

Step 3: Update Legal Info

Update a member's legal information required for card issuance:

curl -X PATCH https://api.brighty.codes/business/v1/members/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/legalInfo \
  -H "Authorization: Bearer ${BRIGHTY_API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "legalName": {
      "firstName": "Alice",
      "lastName": "Johnson"
    },
    "birthInfo": {
      "birthDate": "1992-07-10",
      "birthPlace": {
        "city": "Paris",
        "country": "FR"
      }
    },
    "nationality": "FR"
  }'

This endpoint returns 204 No Content on success with no response body. Use the List Members endpoint to verify the updated legal data.

Step 4: Remove Members

Remove members from your business:

curl -X POST https://api.brighty.codes/business/v1/members/remove \
  -H "Authorization: Bearer ${BRIGHTY_API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "members": [
      "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
    ]
  }'

This endpoint returns 204 No Content on success.

warning

Before removing a member, make sure to terminate all their active cards first. See the Card Management guide for card termination instructions.

Preparing Members for Card Issuance

Before issuing a card for a member, the following legal data fields must be filled in:

• legalName — first name and last name
• birthInfo — date of birth (birthDate) and place of birth (birthPlace with city and country)
• nationality — ISO 3166-1 alpha-2 country code

If a member was added without legal data, use the Update Legal Info endpoint to fill in the required fields before proceeding with card issuance.

Once the member's legal data is complete, follow the Card Issuance guide to issue a card.