Skip to main content

​
Introduction

Customers represent end-users of your platform. Each customer can:
  • Hold balances in BRL, USDT, and BTC
  • Execute trades between currencies
  • Receive and send Pix payments
  • Perform on-chain and Lightning transactions

​
Customer types

Bipa supports two customer types for the Brazilian market:

Individual (PF)

Brazilian individuals identified by CPF. Suitable for retail users, freelancers, and sole proprietors.

Business (PJ)

Brazilian companies identified by CNPJ. Requires legal representatives and additional documentation.

​
Customer lifecycle

StatusDescription
pendingCustomer created, awaiting KYC verification
activeFully verified and operational
suspendedTemporarily restricted (compliance review)
rejectedKYC verification failed
inactiveAccount closed

​
The customer object

{
  "id": "cus_a1b2c3d4e5f6",
  "type": "individual",
  "status": "active",
  "document": {
    "type": "cpf",
    "number": "***456789**"
  },
  "name": "João Silva",
  "email": "[email protected]",
  "phone": "+5511999999999",
  "address": {
    "street": "Av. Paulista",
    "number": "1000",
    "complement": "Sala 101",
    "neighborhood": "Bela Vista",
    "city": "São Paulo",
    "state": "SP",
    "postal_code": "01310100"
  },
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

​
Attributes

AttributeTypeDescription
idstringUnique identifier with cus_ prefix
typestringindividual or business
statusstringCurrent customer status
documentobjectCPF/CNPJ document (partially masked)
namestringFull name (individual) or trade name (business)
emailstringContact email address
phonestringPhone number in E.164 format
addressobjectBrazilian address
created_atstringISO 8601 creation timestamp
updated_atstringISO 8601 last update timestamp

​
Endpoints

Create Individual

Create a customer with CPF

Create Business

Create a customer with CNPJ

Get Customer

Retrieve a customer by ID

List Customers

List all customers

Update Customer

Update customer details

​
KYC requirements

​
Individual customers (PF)

FieldRequiredDescription
nameYesFull legal name
document.numberYesValid CPF (11 digits)
emailYesValid email address
phoneYesBrazilian phone number
birth_dateYesDate of birth (18+ years)
addressYesComplete Brazilian address

​
Business customers (PJ)

FieldRequiredDescription
legal_nameYesRegistered company name
trade_nameNoDoing business as (DBA)
document.numberYesValid CNPJ (14 digits)
emailYesCompany email address
phoneYesCompany phone number
addressYesRegistered business address
representativesYesAt least one legal representative
KYC verification typically completes within minutes for individuals and up to 24 hours for businesses.