Company

Este objeto representa uma empresa do seu negócio. Ele permite que você crie vínculos empregatícios e rastreie contratos que pertencem a mesma empresa.

id string
Identificador exclusivo para o objeto.
Example: comp_5f92f01728e009f403d8502e
status string
Identifica se a empresa está ativa para receber novos empréstimos.
Possible values: [active, inactive]
Default value: active
Example: active
document string
Documento de identificação da empresa. Deve ser o CNPJ.
Possible values: Value must match regular expression ^[0-9]+
Example: 12123123000112
name string
Razão social
Example: Big Corporation SA
friendlyName string
Nome fantasia
Example: Big Corp
group string
Grupo empresarial que a empresa faz parte. [Expansível]
Example: cgrp_5f92f01728e009f403d8502e

address

object

A especificação de um endereço

city stringrequired

Cidade ou distrito.

Example: São Paulo

state stringrequired

Estado, município, província ou região.

Example: SP

country stringrequired

Código de país de duas letras (ISO 3166-1 alpha-2).

Example: BR

line1 stringrequired

Linha de endereço 1 (por exemplo, rua, caixa postal).

Example: Av Paulista

line2 string

Linha de endereço 2 (por exemplo, apartamento, suíte, unidade ou prédio).

Example: Sala 404

number stringrequired

Número do endereço.

Example: 123

postalCode stringrequired

CEP ou Código postal.

Example: 12123123

neighborhood stringrequired

Bairro.

Example: Bela Vista

creditPolicies

object[]

Array [

id string

Example: cpol_63ss07b6c39f5d3d917009b631

]

settings

object

steps

property name*

SettingsSteps

Configurações do modo passo a passo

title string

Título identificador do passo.

type string

Tipo identificador do passo.

Possible values: [signature, disburse, document_verification, pass, valid_employment, custom_request, create_documents, attachments_to_request, unico]

methodData

object

Objeto que contém dados específicos para o tipo de etapa. Por exemplo, se a etapa for do tipo signature, este objeto conterá os dados necessários para a assinatura do documento.

anyOf

signature

Configuração do responsável pela assinatura.

type string

Tipo responsável pela assinatura.

Possible values: [operator, customer]

role string

Papel assumido.

Possible values: [approver, financial, administrator, backoffice]

Example: approver

document_verification

Tipo de documento para verificação.

purpose string

Propósito

Possible values: [account_requirement, org_icon, org_logo, identity_document, additional_verification, selfie, ccb, signature, ccb_signed, insurance, identity_document_front, identity_document_back, pay_stub, proof_of_address, insurance_signature, insurance_signed]

valid_employment

Configuração para validação de employment.

createdBy string

Definição de quem deveria ter criado o employment.

Possible values: [customer, operator]

custom_request

Configuração para realizar a request customizável.

url stringrequired

Url a ser chamada.

Example: https://api.example.com

headers object

Valor do header Authorization

create_documents

Configuração para criar documentos.

documents

object[]

Documentos criados após a criação do empréstimo, exemplos: ccb, seguro, etc…

Array [

purpose string

Possible values: [ccb, signature, insurance]

engine

object

type string

Template engine usado para gerar documentos.

Possible values: [google]

options

object

template string

Template utilizado no engine para gerar o documento.

]

unico

Configuração de integração com a unico.io.

minScore number

Score mínimo aceito na validação de identidade. Esta propriedade somente será utilizada se o resultado da validação da biometria UNICO não for conclusiva. Para maiores informações, consulte o funcionamento do score.

Possible values: >= -100 and <= 100

Example: 70

attachments_to_request

Tipo de anexos para verificação.

purpose string[]

Possible values: [account_requirement, identity_document, additional_verification, selfie, identity_document_front, identity_document_back, pay_stub, proof_of_address]

needs string[]

Array de dependência (slugs) entre os passos necessarios para que esse seja executado.

slug string

Identificador único do passo.

hooks

object

Definição de hooks da esteira.

onFailure

object[]

Lista de ações que serão executadas se um passo da esteira falhar.

Array [

action string

Possible values: [void_loan, cancel_loan]

Example: ["void_loan"]

description string

Example: Ação de cancelamento de empréstimo.

]

onStart

object[]

Lista de ações que serão executadas ao iniciar um passo da esteira.

Array [

action string

Possible values: [mark_loan_as_pending]

Example: ["mark_loan_as_pending"]

description string

Example: Marcar o empréstimo como pendente.

]

loans

object

Configurações de empréstimos

concurrency

object[]

Configurações referentes às limitações na criação de loans simultâneos.

Array [

quantityAllowed number

Número de empréstimos permitidos.

status string[]

Status a ser considerado na limitação da criação dos empréstimos.

Possible values: [open, disbursed, disbursing, repaid, void, canceled, expired, pending, draft]

]

conditions

object[]

Termos e Condições do empréstimo.

Array [

title string

Texto identificador da condição de empréstimos.

content string

Conteúdo da condição.

]

refin

object

Configurações referentes à refinanciamento de empréstimos.

minDays number

Número mínimo de dias necessário para que uma proposta possa ser refinanciada, contado a partir da criação da proposta.

expireInDays number

Número de dias para expiração de um empréstimo, contando a partir da data de criação.

invoices

object

Configurações de faturas

payOff

object

Configurações de quitação.

fine

object

Definição de incidência de multas. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.

amount number

Valor da multa representado em base decimal. A Multa é cobrada uma única vez independente do número de dias de vencimento. O valor máximo para multa é de 2% (0.02).

Example: 0.02

daysToStart integer

Quantidade de dias após o vencimento que a multa começará a incidir.

Example: 1

interest

object

Definição de incidência de juros. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.

amount number

Valor de juros representado em base decimal e ao mês. O valor máximo permitido é 1% (0.01). Os Juros são definidos ao mês, mas calculo para o pagamento após o vencimento converte para juros ao dia e aplica a quantidade de dias em atraso.

Example: 0.01

daysToStart integer

Quantidade de dias após o vencimento que juro começará a incidir.

Example: 1

allowOverduePayment boolean

Permite pagamento da fatura após o vencimento.

Example: true

daysUntilDue

object

Definição de regras para o fechamento da fatura.

type string

Tipo de dias. Absoluto representa uma composição de um determinado dia somado ao valor definido em amount. O resultado dessa soma será considerado a data para fechamento da fatura. Exemplo: dia 5 + amount (3) 08/mês/ano.

Possible values: [absolute]

Example: absolute

amount number

Dia exato ou a quantidade de dias.

Possible values: >= 1 and <= 28

Example: 1

updateInvoiceItemOnInsert boolean

Define se no ato de criar o item de fatura será calculado automaticamente descontos/multa para a fatura em contexto. Os valores base usados nesse cálculos são originados de payOff, customerRecurring ou companyRecurring.

Example: true

companyRecurring

object

Configuração de recorrência de fatura.

fine

object

Definição de incidência de multas. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.

amount number

Valor da multa representado em base decimal. A Multa é cobrada uma única vez independente do número de dias de vencimento. O valor máximo para multa é de 2% (0.02).

Example: 0.02

daysToStart integer

Quantidade de dias após o vencimento que a multa começará a incidir.

Example: 1

interest

object

Definição de incidência de juros. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.

amount number

Valor de juros representado em base decimal e ao mês. O valor máximo permitido é 1% (0.01). Os Juros são definidos ao mês, mas calculo para o pagamento após o vencimento converte para juros ao dia e aplica a quantidade de dias em atraso.

Example: 0.01

daysToStart integer

Quantidade de dias após o vencimento que juro começará a incidir.

Example: 1

allowOverduePayment boolean

Permite pagamento da fatura após o vencimento.

Example: true

daysUntilDue

object

Definição de regras para o fechamento da fatura.

type string

Tipo de dias usado no fechamento da fatura. Representa o dia do mês (1 até 28) para fechamento da fatura.

Possible values: [static]

Example: static

amount number

Dia do mês para fechamento da fatura.

Possible values: >= 1 and <= 28

Example: 10

create

object

Definição de regras para geração de fatura.

cutoffDay number

Define o dia limite para a edição de uma fatura, antes que ela seja fechada.

Example: 25

autoCreate boolean

Define se a fatura deve ser criada automaticamente.

Example: true

updateInvoiceItemOnInsert boolean

Define se no ato de criar o item de fatura será calculado automaticamente descontos/multa para a fatura em contexto. Os valores base usados nesse cálculos são originados de payOff, customerRecurring ou companyRecurring.

Example: false

employments

object

Configurações de vínculos empregatícios

expireInDays integer

Quantidade de dias para expirar o vínculo empregatício.

Example: 30

canUpdateEmploymentData boolean

Se o customer pode atualizar o salário caso o employment esteja expirado.

Example: true
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 date-time
Data de criação do objeto
Example: 2023-08-25T22:38:41.134Z
updatedAt date-time
Data de alteração do objeto
Example: 2023-08-25T22:38:41.134Z
deleted boolean
Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.
Default value: false
Example: false

createdBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice