POST
/
v1
/
companies

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Chave única de idempotência para evitar duplicação de requisições.

Query Parameters

expand
string

Expande as referências.

Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

fields
string[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Body

application/json
status
enum<string>
default: active

Identifica se a empresa está ativa para receber novos empréstimos.

Available options:
active,
inactive
document
string
required

Documento de identificação da empresa. Deve ser o CNPJ.

name
string
required

Razão social

friendlyName
string

Nome fantasia

group
string

Grupo empresarial que a empresa faz parte. [Expansível]

address
object

A especificação de um endereço

creditPolicies
object[]
settings
object
metadata
object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

Response

201 - application/json
id
string

Identificador exclusivo para o objeto.

status
enum<string>
default: active

Identifica se a empresa está ativa para receber novos empréstimos.

Available options:
active,
inactive
document
string

Documento de identificação da empresa. Deve ser o CNPJ.

name
string

Razão social

friendlyName
string

Nome fantasia

group
string

Grupo empresarial que a empresa faz parte. [Expansível]

address
object

A especificação de um endereço

creditPolicies
object[]
settings
object
metadata
object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

createdAt
string

Data de criação do objeto

updatedAt
string

Data de alteração do objeto

deleted
boolean
default: false

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Pesquisar empresasAtualizar empresa