Create a new customer

Create a new customer to send or request funds.

Recipes
🦉
OFPI Create Customer
Open Recipe
Body Params
string
required
length between 11 and 14

The customer's CPF or CNPJ number.

string
length between 5 and 200

The full name of the customer you want to create.

string

The customer's email address.

string | null

The customer's phone number.

string | null

The customer's physical address.

Responses

Response body
object
string
required

Belvo's unique identifier for the current item.

date-time
required

The ISO-8601 timestamp of when the data point was created in Belvo's database.

string
required

The unique ID for the user that created this item.

string
required
length between 8 and 10

The type of customer. Can be either:

  • INDIVIDUAL
  • BUSINESS (Brazil OFPI only)

INDIVIDUAL BUSINESS

string | null
required

The full name of the customer.

string | null
required

The customer's country of residence.

  • BRA (🇧🇷 Brazil)

BRA null

string | null
required

The customer's email address.

string
required
length between 11 and 14

The document number of the customer's ID (depending on the identifier_type).

string
required

The customer's ID document type. For Brazil, this can be either:

  • CPF (when customer_type is INDIVIDUAL)
  • CNPJ (when customer_type is BUSINESS)

CPF CNPJ

string | null

The customers physical address.

string | null

The customer's phone number.

Language
Credentials
: