Skip to main content
POST
/
v1
/
client
Criar cliente
curl --request POST \
  --url https://sandbox.api.veepag.com/v1/client \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --data '
{
  "companyId": "company_id",
  "name": "Cliente Teste",
  "doc": "12345678909",
  "email": "cliente@example.com"
}
'
{
  "_id": "client_id",
  "companyId": "company_id",
  "name": "Cliente Teste",
  "doc": "12345678909"
}

Authorizations

​
apiKey
string
header
required

API key no formato keyId.secret.

Body

application/json
​
companyId
string
required
Minimum string length: 1
​
name
string
required
Minimum string length: 1
​
doc
string
required
Minimum string length: 1
​
type
enum<string> | null
Available options:
INDIVIDUAL,
COMPANY
​
referenceId
string | null
​
birth
string | null
​
email
string<email> | null
​
phone
string[] | null
​
note
string | null
​
address
object
​
device
object
​
ipAddress
string | null

Response

Cliente criado.

​
_id
string
​
companyId
string
​
name
string
​
doc
string
​
cpf
string
​
email
string<email>
​
phone
string[]
​
status
enum<string>
Available options:
ACTIVE,
ERROR_PAYMENT,
PENDING_PAYMENT,
NO_PAYMENT,
CANCELED_ALERT_ETHOCA
​
type
enum<string>
Available options:
INDIVIDUAL,
COMPANY
​
active
boolean
​
deleted
boolean
​
referenceId
string
​
createdAt
string<date-time>
​
lastUpdate
string<date-time>