POST
/
v1
/
loans
/
{loan}
/
attach
curl --request POST \
  --url https://api.base39.io/v1/loans/{loan}/attach \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "file": "file_6307b6c39f5d3d917009b631"
}'
{
  "id": "loan_5f92f01728e009f403d8502e",
  "status": "open",
  "externalId": "4eeb7525-40c6-45fe-8236-2b731d740fad",
  "employment": "<string>",
  "customer": "<string>",
  "company": "<string>",
  "contractNumber": "AB123456789",
  "cashout": [
    {
      "amount": 123,
      "paymentMethod": "<string>",
      "type": "payment_method"
    }
  ],
  "offer": {
    "id": "offr_5f92f01728e009f403d8502e",
    "disbursementAmount": 123,
    "installmentAmount": 123,
    "totalAmount": 123,
    "interestAmount": 123,
    "iofAmount": 123,
    "iofAdditionalAmount": 123,
    "monthlyCET": 0.02,
    "yearlyCET": 0.12,
    "monthlyFee": 0.02,
    "yearlyFee": 0.12,
    "insurance": {
      "amount": 123,
      "fee": 0.02,
      "type": "required",
      "number": "<string>",
      "insurer": "<string>"
    },
    "interestType": "<string>",
    "creditOperationType": "<string>",
    "expectedDisbursementDate": "2023-12-25",
    "interestGracePeriod": 123,
    "principalGracePeriod": 123,
    "numberOfInstallments": 123,
    "firstDueDate": "2023-12-25",
    "fund": "fund_637b85aaa8e91c82fd053aac",
    "product": "prod_637cf14e316408250c0bd067",
    "description": "<string>",
    "rebates": [
      {
        "feeType": "tac",
        "amountType": "absolute",
        "amount": 200,
        "description": "<string>"
      }
    ],
    "fine": {
      "fineRate": 0.02,
      "interestBase": "workdays",
      "monthlyRate": 0.02
    },
    "cashout": [
      {
        "amount": 123,
        "paymentMethod": "<string>",
        "type": "<string>"
      }
    ],
    "creditPolicy": "crpl_637b85aaa8e91c82fd053aac",
    "metadata": {},
    "createdAt": "2023-08-25T22:38:41.134Z"
  },
  "transactions": [
    {
      "amount": 123,
      "description": "<string>",
      "createdAt": "2023-12-25"
    }
  ],
  "attachments": [
    {
      "file": "file_6307b6c39f5d3d917009b631",
      "linkedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "context": {
    "ip": "<string>",
    "headers": {},
    "fingerprint": "<string>",
    "geolocation": [
      "<string>"
    ]
  },
  "history": [
    {
      "description": "<string>",
      "status": "open",
      "metadata": {},
      "createdAt": "2023-08-25T22:38:41.134Z"
    }
  ],
  "signatures": [
    {
      "signer": "<string>",
      "context": {
        "id": "sign_5f92f01728e009f403d8502e",
        "signedAt": "2023-12-25",
        "metadata": {},
        "context": {
          "ip": "<string>",
          "headers": {},
          "fingerprint": "<string>",
          "geolocation": [
            "<string>"
          ]
        }
      }
    }
  ],
  "amountRemaining": 1500,
  "amountForPayment": 1487.9,
  "isRefinancing": false,
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z",
  "updatedAt": "2023-08-25T22:38:41.134Z",
  "deleted": false
}

Authorizations

​
Authorization
string
header
required

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.

Path Parameters

​
loan
string
required

ID do empréstimo

Query Parameters

​
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.

​
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.

Body

application/json
​
file
string
required
Example:

"file_6307b6c39f5d3d917009b631"

Response

200 - application/json
Retorna o objeto `Loan` se o arquivo for anexado com sucesso.

Este objeto representa um empréstimo.

​
id
string

Identificador exclusivo para o objeto.

Example:

"loan_5f92f01728e009f403d8502e"

​
status
string
default:open

Status do empréstimo

Example:

"open"

​
externalId
string
Example:

"4eeb7525-40c6-45fe-8236-2b731d740fad"

​
employment
string

Id do vinculo empregatício ou um objeto com os dados do vinculo empregatício nas operações de leitura quando usado o modo expand.

​
customer
string

Id do cliente ou um objeto com os dados do cliente nas operações de leitura quando usado o modo expand.

​
company
string

Id da empresa ou um objeto com os dados da empresa nas operações de leitura quando usado o modo expand.

​
contractNumber
string

Número do contrato

Example:

"AB123456789"

​
cashout
object[]

Especificação para desembolso em conta bancária

​
offer
object

Este objeto representa uma oferta de um empréstimo.

​
transactions
object[]

A especificação de um endereço

​
attachments
object[]
​
context
object

Informação do contexto da operação. Usado para segurança e formalização. IP, Headers, Fingerprint, and Geolocation

​
history
object[]
​
signatures
object[]
​
amountRemaining
number

Valor restante para pagamento, será apresentado caso seja informado o parâmetro payment_for.

Example:

1500

​
amountForPayment
number

Valor para pagamento, será apresentado caso seja informado o parâmetro payment_for.

Example:

1487.9

​
isRefinancing
string

Este campo informa se o empréstimo é um refinanciamento. Ele é preenchido automaticamente, levando em conta os dados do campo cashout, e não pode ser preenchido de forma manual.

Example:

false

​
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

Example:

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

​
updatedAt
string

Data de alteração do objeto

Example:

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

​
deleted
boolean
default:false

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

Example:

false