Respostas do assistente de primeiro acesso
curl --request POST \
--url https://v4pay-api.vercel.app/auth/onboarding \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"cpf": "<string>",
"phone": "<string>",
"company": "<string>",
"has_cnpj": true,
"cnpj": "<string>",
"postal_code": "<string>",
"address": "<string>",
"address_number": "<string>",
"complement": "<string>",
"province": "<string>"
}
'import requests
url = "https://v4pay-api.vercel.app/auth/onboarding"
payload = {
"name": "<string>",
"cpf": "<string>",
"phone": "<string>",
"company": "<string>",
"has_cnpj": True,
"cnpj": "<string>",
"postal_code": "<string>",
"address": "<string>",
"address_number": "<string>",
"complement": "<string>",
"province": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
cpf: '<string>',
phone: '<string>',
company: '<string>',
has_cnpj: true,
cnpj: '<string>',
postal_code: '<string>',
address: '<string>',
address_number: '<string>',
complement: '<string>',
province: '<string>'
})
};
fetch('https://v4pay-api.vercel.app/auth/onboarding', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://v4pay-api.vercel.app/auth/onboarding",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'cpf' => '<string>',
'phone' => '<string>',
'company' => '<string>',
'has_cnpj' => true,
'cnpj' => '<string>',
'postal_code' => '<string>',
'address' => '<string>',
'address_number' => '<string>',
'complement' => '<string>',
'province' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://v4pay-api.vercel.app/auth/onboarding"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"cpf\": \"<string>\",\n \"phone\": \"<string>\",\n \"company\": \"<string>\",\n \"has_cnpj\": true,\n \"cnpj\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"address\": \"<string>\",\n \"address_number\": \"<string>\",\n \"complement\": \"<string>\",\n \"province\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://v4pay-api.vercel.app/auth/onboarding")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"cpf\": \"<string>\",\n \"phone\": \"<string>\",\n \"company\": \"<string>\",\n \"has_cnpj\": true,\n \"cnpj\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"address\": \"<string>\",\n \"address_number\": \"<string>\",\n \"complement\": \"<string>\",\n \"province\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://v4pay-api.vercel.app/auth/onboarding")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"cpf\": \"<string>\",\n \"phone\": \"<string>\",\n \"company\": \"<string>\",\n \"has_cnpj\": true,\n \"cnpj\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"address\": \"<string>\",\n \"address_number\": \"<string>\",\n \"complement\": \"<string>\",\n \"province\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"error": {
"message": "<string>"
}
}{
"error": "Token JWT ou chave de API ausente"
}Interno
Respostas do assistente de primeiro acesso
Grava de uma vez o que o lojista responde no assistente do painel (origem, responsável, nome da loja, se tem CNPJ, dados e endereço da empresa, segmento, faixa de faturamento) e marca onboarding_completed_at. Não abre a subconta: para isso o painel chama POST /receiving-account em seguida, quando há CNPJ. Só o nome é obrigatório, e apenas se enviado.
POST
/
auth
/
onboarding
Respostas do assistente de primeiro acesso
curl --request POST \
--url https://v4pay-api.vercel.app/auth/onboarding \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"cpf": "<string>",
"phone": "<string>",
"company": "<string>",
"has_cnpj": true,
"cnpj": "<string>",
"postal_code": "<string>",
"address": "<string>",
"address_number": "<string>",
"complement": "<string>",
"province": "<string>"
}
'import requests
url = "https://v4pay-api.vercel.app/auth/onboarding"
payload = {
"name": "<string>",
"cpf": "<string>",
"phone": "<string>",
"company": "<string>",
"has_cnpj": True,
"cnpj": "<string>",
"postal_code": "<string>",
"address": "<string>",
"address_number": "<string>",
"complement": "<string>",
"province": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
cpf: '<string>',
phone: '<string>',
company: '<string>',
has_cnpj: true,
cnpj: '<string>',
postal_code: '<string>',
address: '<string>',
address_number: '<string>',
complement: '<string>',
province: '<string>'
})
};
fetch('https://v4pay-api.vercel.app/auth/onboarding', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://v4pay-api.vercel.app/auth/onboarding",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'cpf' => '<string>',
'phone' => '<string>',
'company' => '<string>',
'has_cnpj' => true,
'cnpj' => '<string>',
'postal_code' => '<string>',
'address' => '<string>',
'address_number' => '<string>',
'complement' => '<string>',
'province' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://v4pay-api.vercel.app/auth/onboarding"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"cpf\": \"<string>\",\n \"phone\": \"<string>\",\n \"company\": \"<string>\",\n \"has_cnpj\": true,\n \"cnpj\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"address\": \"<string>\",\n \"address_number\": \"<string>\",\n \"complement\": \"<string>\",\n \"province\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://v4pay-api.vercel.app/auth/onboarding")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"cpf\": \"<string>\",\n \"phone\": \"<string>\",\n \"company\": \"<string>\",\n \"has_cnpj\": true,\n \"cnpj\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"address\": \"<string>\",\n \"address_number\": \"<string>\",\n \"complement\": \"<string>\",\n \"province\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://v4pay-api.vercel.app/auth/onboarding")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"cpf\": \"<string>\",\n \"phone\": \"<string>\",\n \"company\": \"<string>\",\n \"has_cnpj\": true,\n \"cnpj\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"address\": \"<string>\",\n \"address_number\": \"<string>\",\n \"complement\": \"<string>\",\n \"province\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"error": {
"message": "<string>"
}
}{
"error": "Token JWT ou chave de API ausente"
}Authorizations
Token JWT obtido em /auth/login, enviado no cabeçalho Authorization no formato Bearer <token>.
Body
application/json
Available options:
google, instagram, linkedin, youtube, indicacao, evento, v4company, outro, null Celular com DDD
Nome da loja (aparece no comprovante)
Available options:
MEI, LIMITED, INDIVIDUAL, ASSOCIATION, null Bairro
Available options:
infoprodutos, ecommerce, saas, servicos, marketplace, agentes_ia, outro, null Available options:
ate_30k, 30k_300k, acima_300k, null Response
Respostas gravadas; devolve o usuário atualizado (com onboarding_completed_at).