Skip to main content
POST
Cadastrar empresa

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

api-key
string
header
required

Obrigatório. Sua chave API.

Body

application/json
documento
string
required
tipo_documento
enum<string>
required
Available options:
CPF,
CNPJ
numero_contrato
required
razao_social
string
required
nome_fantasia
string
required
endereco
object
required
telefone
object
required
situacao_cadastral
enum<string>
required

A - Ativo, S - Suspenso, G - Aguardando Ativação

Available options:
A,
S,
G
categorias
integer[]
required

Lista de categorias atendidas pela empresa. Limite máximo de 1000 itens. Array vazio ([]) indica todas as categorias.

Maximum array length: 1000
tipos_pagamento
enum<string>[]
required

Array vazio indica todos os tipos. B: Débito (máquina), C: Crédito (máquina), D: Dinheiro, F: Faturado, H: Whatsapp, P: Picpay, R: Carteira de Créditos, X: Pix

Available options:
B,
C,
D,
F,
H,
P,
R,
X
cobrar_retorno
boolean
required
obrigar_finalizacao_com_retorno_pela_empresa
boolean
required
solicitacao_rapida
object
required
area_atuacao_empresa_id
integer
observacao_condutor
string
dados_extras
string

Response

200 - application/json

Sucesso