Companies

Uma lista de empresas.

hasMoreboolean

Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.

Example: true

data object[]

Uma lista de empresas

Array [

idstring

Identificador exclusivo para o objeto.

Example: comp_5f92f01728e009f403d8502e

statusstring

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

Possible values: [active, inactive]

Default value: active

Example: active

documentstring

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

Possible values: Value must match regular expression ^[0-9]+

Example: 12123123000112

namestring

Razão social

Example: Big Corporation SA

friendlyNamestring

Nome fantasia

Example: Big Corp

groupstring

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

Example: cgrp_5f92f01728e009f403d8502e

address object

A especificação de um endereço

citystringrequired

Cidade ou distrito.

Example: São Paulo

statestringrequired

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

Example: SP

countrystringrequired

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

Example: BR

line1stringrequired

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

Example: Av Paulista

line2string

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

Example: Sala 404

numberstringrequired

Número do endereço.

Example: 123

postalCodestringrequired

CEP ou Código postal.

Example: 12123123

neighborhoodstringrequired

Bairro.

Example: Bela Vista

creditPolicies object[]

Array [

idstring

Example: cpol_63ss07b6c39f5d3d917009b631

]

settings object

steps

property name* SettingsSteps

Configurações do modo passo a passo

titlestring

Título identificador do passo.

typestring

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

typestring

Tipo responsável pela assinatura.

Possible values: [operator, customer]

rolestring

Papel assumido.

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

Example: approver

document_verification

purposestring

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

createdBystring

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

Possible values: [customer, operator]

custom_request

urlstringrequired

Url a ser chamada.

Example: https://api.example.com

headersobject

Valor do header Authorization

create_documents

unico

minScorenumber

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

purposestring[]

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

needsstring[]

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

slugstring

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 [

actionstring

Possible values: [void_loan, cancel_loan]

Example: ["void_loan"]

descriptionstring

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 [

actionstring

Possible values: [mark_loan_as_pending]

Example: ["mark_loan_as_pending"]

descriptionstring

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 [

quantityAllowednumber

Número de empréstimos permitidos.

statusstring[]

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 [

titlestring

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

contentstring

Conteúdo da condição.

]

refin object

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

minDaysnumber

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

expireInDaysnumber

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.

amountnumber

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

daysToStartinteger

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.

amountnumber

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

daysToStartinteger

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

Example: 1

allowOverduePaymentboolean

Permite pagamento da fatura após o vencimento.

Example: true

daysUntilDue object

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

typestring

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

amountnumber

Dia exato ou a quantidade de dias.

Possible values: >= 1 and <= 28

Example: 1

updateInvoiceItemOnInsertboolean

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.

amountnumber

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

daysToStartinteger

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.

amountnumber

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

daysToStartinteger

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

Example: 1

allowOverduePaymentboolean

Permite pagamento da fatura após o vencimento.

Example: true

daysUntilDue object

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

typestring

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

amountnumber

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.

cutoffDaynumber

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

Example: 25

autoCreateboolean

Define se a fatura deve ser criada automaticamente.

Example: true

updateInvoiceItemOnInsertboolean

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

expireInDaysinteger

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

Example: 30

canUpdateEmploymentDataboolean

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

Example: true

installments object

Configurações de parcelas

firstDueDate object

Configurações de dia de corte da primeira parcela e tempo de carência para a primeira parcela.

firstCutoffDatenumber

Dia de corte da primeira parcela. Qualquer dia entre 1 e 28

Example: 1

monthsOfGracenumber

Quantidade em meses de carência da primeira parcela.

Example: 1

metadataobject

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.

createdAtdate-time

Data de criação do objeto

Example: 2023-08-25T22:38:41.134Z

updatedAtdate-time

Data de alteração do objeto

Example: 2023-08-25T22:38:41.134Z

deletedboolean

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

Default value: false

Example: false

createdBy object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

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.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

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.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

]

Companies

{
  "hasMore": true,
  "data": [
    {
      "id": "comp_5f92f01728e009f403d8502e",
      "status": "active",
      "document": "12123123000112",
      "name": "Big Corporation SA",
      "friendlyName": "Big Corp",
      "group": "cgrp_5f92f01728e009f403d8502e",
      "address": {
        "city": "São Paulo",
        "state": "SP",
        "country": "BR",
        "line1": "Av Paulista",
        "line2": "Sala 404",
        "number": "123",
        "postalCode": "12123123",
        "neighborhood": "Bela Vista"
      },
      "creditPolicies": [
        {
          "id": "cpol_63ss07b6c39f5d3d917009b631"
        }
      ],
      "settings": {
        "loans": {
          "concurrency": [
            {
              "quantityAllowed": 0,
              "status": [
                "open"
              ]
            }
          ],
          "conditions": [
            {
              "title": "string",
              "content": "string"
            }
          ],
          "refin": {
            "minDays": 0
          },
          "expireInDays": 0
        },
        "invoices": {
          "payOff": {
            "fine": {
              "amount": 0.02,
              "daysToStart": 1
            },
            "interest": {
              "amount": 0.01,
              "daysToStart": 1
            },
            "allowOverduePayment": true,
            "daysUntilDue": {
              "type": "absolute",
              "amount": 1
            },
            "updateInvoiceItemOnInsert": true
          },
          "companyRecurring": {
            "fine": {
              "amount": 0.02,
              "daysToStart": 1
            },
            "interest": {
              "amount": 0.01,
              "daysToStart": 1
            },
            "allowOverduePayment": true,
            "daysUntilDue": {
              "type": "static",
              "amount": 10
            },
            "create": {
              "cutoffDay": 25,
              "autoCreate": true
            },
            "updateInvoiceItemOnInsert": false
          }
        },
        "employments": {
          "expireInDays": 30,
          "canUpdateEmploymentData": true
        },
        "installments": {
          "firstDueDate": {
            "firstCutoffDate": 1,
            "monthsOfGrace": 1
          }
        }
      },
      "metadata": {},
      "createdAt": "2023-08-25T22:38:41.134Z",
      "updatedAt": "2023-08-25T22:38:41.134Z",
      "deleted": false,
      "createdBy": {
        "clientId": "client_identifier",
        "externalClientId": "string",
        "app": "backoffice"
      },
      "updatedBy": {
        "clientId": "client_identifier",
        "externalClientId": "string",
        "app": "backoffice"
      }
    }
  ]
}