Affiliates

Affiliate resource client for partner affiliate operations

Access through sdk.affiliates on a Lomadee instance. Import types from @thelomadee/sdk/domains.

import type {
  AffiliateQuery,
  AffiliateListResponse,
  AffiliateListItem,
  AffiliateCluster,
  SignUpBody,
  UpdateAffiliateBody,
  AffiliateResponse,
  AffiliateInviteStatus,
  DocumentType,
} from '@thelomadee/sdk/domains';
import type { SdkResponse } from '@thelomadee/sdk';

Signup and affiliate payloads include PII and financial data (documents, bank accounts, PIX). Collect, transmit, and store them only on the server with appropriate access controls and compliance measures.

list

list(query: AffiliateQuery): Promise<AffiliateListResponse>

Parameters — AffiliateQuery

search · string

Optional search string.

page · number

Optional page index.

limit · number

Optional page size.

affiliateIds · string[]

Optional filter by affiliate identifiers.

Returns

Promise<AffiliateListResponse> — { data: AffiliateListItem[]; count: number }.

Example

const { data, count } = await sdk.affiliates.list({ page: 1, limit: 20 });

---

get

get(id: string): Promise<AffiliateResponse>

id · string · required

Affiliate identifier.

Returns

Promise<AffiliateResponse> — not wrapped in SdkResponse.

---

create

create(body: SignUpBody): Promise<SdkResponse<AffiliateResponse>>

Creates an affiliate via the SDK signup flow (SignUpBody).

Parameters — SignUpBody

user · UserSignUpBody · required

User profile for signup. See UserSignUpBody.

address · UserAddressBody · required

Postal address. See UserAddressBody.

bank · UserBankBody · required

Bank details. See UserBankBody.

Returns

Promise<SdkResponse<AffiliateResponse>> — { data: AffiliateResponse }.

---

update

update(id: string, body: UpdateAffiliateBody): Promise<AffiliateResponse>

id · string · required

Affiliate identifier.

Parameters — UpdateAffiliateBody

user · UpdateUserBody

Optional partial user fields. See UpdateUserBody.

address · UserAddressBody

Optional address replacement. See UserAddressBody.

bank · UserBankBody

Optional bank details. See UserBankBody.

Returns

Promise<AffiliateResponse>.

---

DocumentType

Union type used in signup and user models:

'cpf' | 'cnpj' | 'rg' | 'international' | 'passport'

AffiliateInviteStatus

Union type for affiliate invite state (dashboard-api enum):

Value	Description
'pendent'	Invite pending
'accept'	Invite accepted
'need_approval'	Awaiting approval
'rejected'	Invite rejected

UserSignUpBody

username · string · required

Username.

phone · string

Optional phone number.

email · string · required

Email address.

fullName · string · required

Full legal name.

birthDate · string · required

Birth date (string format not specified in SDK types).

documentType · DocumentType · required

Document type union.

document · string · required

Document number.

pis · string

Optional PIS identifier.

legalName · string

Optional legal entity name.

tradeName · string

Optional trade name.

UserAddressBody

country · string

Optional country. Comment in SDK source: default brazil (default behavior is not enforced by the SDK type).

postalCode · string · required

Postal code.

street · string · required

Street name.

number · string · required

Street number.

complement · string

Optional address complement.

neighbourhood · string · required

Neighbourhood.

city · string · required

City.

state · string · required

State.

UserBankBody

country · string

Optional country. Comment in SDK source: default brazil.

brazilBank · BrazilBankBody

Brazilian bank account. See BrazilBankBody.

internationalBank · InternationalBankBody

International bank account. See InternationalBankBody.

BrazilBankBody

Contains sensitive financial and identity-related fields. Never log full bank or PIX details.

brazilBankId · string · required

Brazilian bank identifier.

agency · string · required

Agency number.

agencyDigit · string · required

Agency check digit.

account · string · required

Account number.

accountDigit · string · required

Account check digit.

accountType · 'CHECKING' | 'SAVINGS' · required

Account type union.

name · string · required

Account holder name.

pix · string · required

PIX key value.

pixType · string · required

PIX key type (string; allowed values not enumerated in SDK types).

InternationalBankBody

Contains sensitive financial data. Never log full account, IBAN, or routing details.

id · string · required

International bank record identifier.

bankName · string · required

Bank name.

bankCountry · string · required

Bank country.

bankAddress · string · required

Bank address.

beneficiaryName · string · required

Beneficiary name.

accountNumber · string · required

Account number.

iban · string · required

IBAN.

swiftBic · string · required

SWIFT/BIC code.

sortCode · string · required

Sort code.

abaRoutingNumber · string · required

ABA routing number.

paymentDetails · string · required

Payment details.

intermediaryBankName · string · required

Intermediary bank name.

intermediaryBankSwift · string · required

Intermediary bank SWIFT.

intermediaryBankAddress · string · required

Intermediary bank address.

UpdateUserBody

All fields optional:

username · string

Username.

phone · string

Phone number.

birthDate · string

Birth date.

documentType · DocumentType

Document type union.

document · string

Document number.

pis · string

PIS identifier.

legalName · string

Legal entity name.

tradeName · string

Trade name.

AffiliateResponse

Response user may contain PII (email, document, phone, address). Handle and log accordingly.

id · string · required

Affiliate identifier.

user · User · required

User record. Address is nested on user, not at the top level. See User.

userOrganizationId · string

Optional user-organization identifier.

inviteStatus · AffiliateInviteStatus | null

Optional invite status, or null. See AffiliateInviteStatus.

inviteHash · string | null

Optional invite hash, or null.

active · boolean

Optional active flag.

AffiliateListItem

Extends AffiliateResponse with cluster membership for list results.

clusters · AffiliateCluster[] · required

Clusters the affiliate belongs to. See AffiliateCluster.

AffiliateListResponse

data · AffiliateListItem[] · required

Page of affiliate list items.

count · number · required

Total count for the query.

AffiliateCluster

id · string · required

Cluster identifier.

name · string · required

Cluster name.

isDefault · boolean · required

Default cluster flag.

active · boolean · required

Active flag.

affiliateCount · number · required

Affiliate count field from API.

affiliatesCount · number · required

Affiliates count field from API.

createdAt · string · required

Creation timestamp.

updatedAt · string · required

Update timestamp.

User

May contain PII. Optional fields reflect mapper optional chaining in the SDK types.

id · string

Optional user identifier.

email · string

Optional email address.

username · string

Optional username.

document · string

Optional document number.

documentType · DocumentType

Optional document type union.

onboardingStatus · 'Completed' | 'Pending'

Optional onboarding status.

avatar · string | null

Optional avatar URL or null.

birthDate · string

Optional birth date.

phone · string

Optional phone number.

createdAt · string

Optional creation timestamp.

updatedAt · string

Optional update timestamp.

address · Address | null

Optional nested address, or null. See Address.

pis · string

Optional PIS identifier.

categories · unknown

Optional categories payload (shape not specified in SDK types).

tradeName · string

Optional trade name.

legalName · string

Optional legal entity name.

position · string

Optional position.

lastLoginAt · string

Optional last login timestamp.

accessCount · number

Optional access count.

Address

Response address model. All fields optional in SDK types.

id · string

Address identifier.

country · string

Country.

cep · string

Postal code (CEP).

address · string

Street address line.

number · string

Street number.

complement · string

Address complement.

neighbourhood · string

Neighbourhood.

state · string

State.

city · string

City.

Example

import type { SignUpBody } from '@thelomadee/sdk/domains';

const body: SignUpBody = {
  user: {
    username: 'partner-user',
    email: '[e-mail]',
    fullName: 'Example User',
    birthDate: '1990-01-01',
    documentType: 'cpf',
    document: '00000000000',
  },
  address: {
    postalCode: '01310100',
    street: 'Example Street',
    number: '100',
    neighbourhood: 'Centro',
    city: 'São Paulo',
    state: 'SP',
  },
  bank: {
    brazilBank: {
      brazilBankId: 'bank-id',
      agency: '0001',
      agencyDigit: '0',
      account: '12345',
      accountDigit: '6',
      accountType: 'CHECKING',
      name: 'Example User',
      pix: '[e-mail]',
      pixType: 'email',
    },
  },
};

const { data: affiliate } = await sdk.affiliates.create(body);

Related

• Client
• Environments and secrets
• Error handling