Skip to main content
POST
/
v1
/
customers
Create a new customer
curl --request POST \
  --url https://api-global.fastpaybrasil.com/v1/customers \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John Doe",
  "email": "[email protected]",
  "documentId": "12345678900",
  "documentType": "cpf",
  "phoneNumber": "+5511999999999"
}
'
{
  "id": "2RhQg9M7ZCg3X3nMb9W1kX8Q"
}

Authorizations

​
Authorization
string
header
required

HTTP Basic authentication. Use your secret key as the username and an empty string as password. The API key should be base64 encoded in the format 'username:' when sending the Authorization header.

Body

application/json
​
name
string
required

Customer's full name

Example:

"John Doe"

​
email
string<email>
required

Customer's email address

Example:

"[email protected]"

​
documentId
string
required

Identification document number (CPF, CNPJ, passport)

Example:

"12345678900"

​
documentType
string
required

Type of document (e.g., cpf, cnpj, passport, rg)

Example:

"cpf"

​
phoneNumber
string

Customer's phone number (optional)

Example:

"+5511999999999"

Response

Customer successfully created

​
id
string

Unique identifier of the created customer

Example:

"2RhQg9M7ZCg3X3nMb9W1kX8Q"