Bit Capital

The Bit Capital Developer Hub

Welcome to the Bit Capital developer hub. You'll find comprehensive guides and documentation to help you start working with the platform as quickly as possible, as well as support if you get stuck. Let's jump right in!

Guides    Community

Consumer

Basic information for Identity Verification and other core features.

Properties

addresses

addresses: AddressSchema[]

The consumer addresses, requires at least one the for the Identity Verification and other core features.

Example:

[{
  "addresses": [{
  "street": "Av Nove de Julho",
  "number": "4939",
  "neighborhood": "Jardim Paulista",
  "code": "01407100",
  "city": "São Paulo",
  "state": "SP",
  "country": "BR",
  "status": "own"
}]

👍

Best Practice

The "street" field support max 40 characters.


birthday

birthday: Date

The consumer birthday, for personal accounts, the user must have more than 18 years old.
If the account type is corporate this is not required.

Format: ISO-8601


Optional companyData

companyData? : CompanyDataSchema

The company registration data with authorities, required if the account type is corporate.


Optional motherName

motherName? : string

The consumer mother name. If the account type is corporate this field is not required.


Optional pep

pep? : boolean

The self-declaration of political exposure.


phones

phones: PhoneSchema[]

The consumer phones, requires at least one the for the Identity Verification and other core features.

Example:

[{
  "code": "11",
  "number": "987654321"
}]

taxId

taxId: string

The consumer Tax ID (CPF or CNPJ) for the account creation and Identity Verification.

requires


type

type: AccountType

The account type for the Identity Verification.

Updated 4 months ago


Consumer


Basic information for Identity Verification and other core features.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.