Skip to main content
POST
/
customers
Criar cliente
curl --request POST \
  --url https://api.conta.paybeehive.com.br/v1/customers \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Bruce Wayne",
  "email": "[email protected]",
  "document": {
    "number": "12345678909",
    "type": "cpf"
  },
  "externalRef": "cust_ext_001",
  "phone": "+5511999999999",
  "birthdate": "1990-01-01",
  "address": {
    "street": "Av. Brigadeiro Faria Lima",
    "number": "1811",
    "complement": "Conj 1119",
    "neighborhood": "Itaim Bibi",
    "city": "São Paulo",
    "state": "SP",
    "zipcode": "01452001",
    "country": "BR"
  }
}
'
{
  "name": "Bruce Wayne",
  "email": "[email protected]",
  "document": {
    "number": "12345678909",
    "type": "cpf"
  },
  "externalRef": "cust_ext_001",
  "phone": "+5511999999999",
  "birthdate": "1990-01-01",
  "address": {
    "street": "Av. Brigadeiro Faria Lima",
    "number": "1811",
    "complement": "Conj 1119",
    "neighborhood": "Itaim Bibi",
    "city": "São Paulo",
    "state": "SP",
    "zipcode": "01452001",
    "country": "BR"
  },
  "id": 123,
  "createdAt": "2026-01-04T12:00:00Z"
}

Authorizations

​
Authorization
string
header
required

Basic Authorization usando SECRET_KEY como usuário e "x" como senha.

Headers

​
Idempotency-Key
string

Chave de idempotência para evitar duplicidade em retries.

Body

application/json
​
name
string
required
Example:

"Bruce Wayne"

​
email
string
required
​
document
object
required
​
externalRef
string
Example:

"cust_ext_001"

​
phone
string
Example:

"+5511999999999"

​
birthdate
string
Example:

"1990-01-01"

​
address
object

Response

Cliente criado

​
name
string
required
Example:

"Bruce Wayne"

​
email
string
required
​
document
object
required
​
externalRef
string
Example:

"cust_ext_001"

​
phone
string
Example:

"+5511999999999"

​
birthdate
string
Example:

"1990-01-01"

​
address
object
​
id
integer
Example:

123

​
createdAt
string
Example:

"2026-01-04T12:00:00Z"