Record signed credit instrument

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/loan-applications/{applicationId}/signed-credit-instrument \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document": "aSDinaTvuI8gbWludGxpZnk=",
  "evidenceRef": "<string>",
  "signatories": [
    {
      "name": "<string>",
      "role": "<string>",
      "signedAt": "2023-11-07T05:31:56Z",
      "taxId": "<string>"
    }
  ],
  "signedAt": "2023-11-07T05:31:56Z",
  "signedDocumentDigest": "<string>",
  "creditInstrumentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "originalDocumentDigest": "<string>",
  "replacementReason": "<string>",
  "supersedes": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/loan-applications/{applicationId}/signed-credit-instrument"

	payload := strings.NewReader("{\n  \"document\": \"aSDinaTvuI8gbWludGxpZnk=\",\n  \"evidenceRef\": \"<string>\",\n  \"signatories\": [\n    {\n      \"name\": \"<string>\",\n      \"role\": \"<string>\",\n      \"signedAt\": \"2023-11-07T05:31:56Z\",\n      \"taxId\": \"<string>\"\n    }\n  ],\n  \"signedAt\": \"2023-11-07T05:31:56Z\",\n  \"signedDocumentDigest\": \"<string>\",\n  \"creditInstrumentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"originalDocumentDigest\": \"<string>\",\n  \"replacementReason\": \"<string>\",\n  \"supersedes\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    document: 'aSDinaTvuI8gbWludGxpZnk=',
    evidenceRef: '<string>',
    signatories: [
      {
        name: '<string>',
        role: '<string>',
        signedAt: '2023-11-07T05:31:56Z',
        taxId: '<string>'
      }
    ],
    signedAt: '2023-11-07T05:31:56Z',
    signedDocumentDigest: '<string>',
    creditInstrumentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    originalDocumentDigest: '<string>',
    replacementReason: '<string>',
    supersedes: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://lender.sandbox.lerian.net/api/v1/loan-applications/{applicationId}/signed-credit-instrument', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://lender.sandbox.lerian.net/api/v1/loan-applications/{applicationId}/signed-credit-instrument"

payload = {
    "document": "aSDinaTvuI8gbWludGxpZnk=",
    "evidenceRef": "<string>",
    "signatories": [
        {
            "name": "<string>",
            "role": "<string>",
            "signedAt": "2023-11-07T05:31:56Z",
            "taxId": "<string>"
        }
    ],
    "signedAt": "2023-11-07T05:31:56Z",
    "signedDocumentDigest": "<string>",
    "creditInstrumentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "originalDocumentDigest": "<string>",
    "replacementReason": "<string>",
    "supersedes": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "custodian": "<string>",
  "evidenceRef": "<string>",
  "id": "<string>",
  "loanApplicationId": "<string>",
  "origin": "<string>",
  "originalDocumentDigest": "<string>",
  "recordedAt": "<string>",
  "signatories": [
    {
      "role": "<string>",
      "signedAt": "<string>"
    }
  ],
  "signedAt": "<string>",
  "signedDocumentDigest": "<string>",
  "signedDocumentSize": 123,
  "creditInstrumentId": "<string>",
  "replacementReason": "<string>",
  "supersedesId": "<string>"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Record signed credit instrument

Records the signed CCB the integrator collected: the Lender computes the document’s sha-256, custodies the bytes, then records which instrument was signed. The same document as the newest record replays it: the replay is keyed on the document’s digest and returns the stored record unchanged, ignoring any metadata that differs in the resend. A different document only enters as a replacement that names the newest record in supersedes and gives a replacementReason; the newest record is the one that counts.

POST

api

loan-applications

{applicationId}

signed-credit-instrument

Record signed credit instrument

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/loan-applications/{applicationId}/signed-credit-instrument \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document": "aSDinaTvuI8gbWludGxpZnk=",
  "evidenceRef": "<string>",
  "signatories": [
    {
      "name": "<string>",
      "role": "<string>",
      "signedAt": "2023-11-07T05:31:56Z",
      "taxId": "<string>"
    }
  ],
  "signedAt": "2023-11-07T05:31:56Z",
  "signedDocumentDigest": "<string>",
  "creditInstrumentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "originalDocumentDigest": "<string>",
  "replacementReason": "<string>",
  "supersedes": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/loan-applications/{applicationId}/signed-credit-instrument"

	payload := strings.NewReader("{\n  \"document\": \"aSDinaTvuI8gbWludGxpZnk=\",\n  \"evidenceRef\": \"<string>\",\n  \"signatories\": [\n    {\n      \"name\": \"<string>\",\n      \"role\": \"<string>\",\n      \"signedAt\": \"2023-11-07T05:31:56Z\",\n      \"taxId\": \"<string>\"\n    }\n  ],\n  \"signedAt\": \"2023-11-07T05:31:56Z\",\n  \"signedDocumentDigest\": \"<string>\",\n  \"creditInstrumentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"originalDocumentDigest\": \"<string>\",\n  \"replacementReason\": \"<string>\",\n  \"supersedes\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    document: 'aSDinaTvuI8gbWludGxpZnk=',
    evidenceRef: '<string>',
    signatories: [
      {
        name: '<string>',
        role: '<string>',
        signedAt: '2023-11-07T05:31:56Z',
        taxId: '<string>'
      }
    ],
    signedAt: '2023-11-07T05:31:56Z',
    signedDocumentDigest: '<string>',
    creditInstrumentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    originalDocumentDigest: '<string>',
    replacementReason: '<string>',
    supersedes: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://lender.sandbox.lerian.net/api/v1/loan-applications/{applicationId}/signed-credit-instrument', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://lender.sandbox.lerian.net/api/v1/loan-applications/{applicationId}/signed-credit-instrument"

payload = {
    "document": "aSDinaTvuI8gbWludGxpZnk=",
    "evidenceRef": "<string>",
    "signatories": [
        {
            "name": "<string>",
            "role": "<string>",
            "signedAt": "2023-11-07T05:31:56Z",
            "taxId": "<string>"
        }
    ],
    "signedAt": "2023-11-07T05:31:56Z",
    "signedDocumentDigest": "<string>",
    "creditInstrumentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "originalDocumentDigest": "<string>",
    "replacementReason": "<string>",
    "supersedes": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "custodian": "<string>",
  "evidenceRef": "<string>",
  "id": "<string>",
  "loanApplicationId": "<string>",
  "origin": "<string>",
  "originalDocumentDigest": "<string>",
  "recordedAt": "<string>",
  "signatories": [
    {
      "role": "<string>",
      "signedAt": "<string>"
    }
  ],
  "signedAt": "<string>",
  "signedDocumentDigest": "<string>",
  "signedDocumentSize": 123,
  "creditInstrumentId": "<string>",
  "replacementReason": "<string>",
  "supersedesId": "<string>"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

applicationId

string<uuid>

requerido

Loan application identifier.

Cuerpo

application/json

document

string<byte>

requerido

The signed PDF, base64-encoded (standard alphabet), at most 20 MiB decoded.

evidenceRef

string

requerido

The integrator's reference to the signature evidence.

Required string length: 1 - 1024

signatories

object[] | null

requerido

Every party that signed.

Required array length: 1 - 20 elements

Show child attributes

signedAt

string<date-time>

requerido

When the signature completed (RFC3339); at most 5 minutes after the Lender's clock, the signature provider's clock skew.

signedDocumentDigest

string

requerido

sha-256 hex of the decoded document. The Lender computes its own and refuses a mismatch (LENDER-0605).

Pattern: ^[0-9a-fA-F]{64}$

creditInstrumentId

string<uuid>

The Lender-emitted CCB that was signed. Required when the product version has the Lender emit; refused when the client issues.

originalDocumentDigest

string

sha-256 hex of the document that was signed. Required when the client issues; when the Lender emitted, optional and checked against its CCB.

Pattern: ^[0-9a-fA-F]{64}$

replacementReason

string

Only to replace: why, in one line of at most 500 characters. Goes with supersedes.

Maximum string length: 500

supersedes

string<uuid>

Only to replace: the id of the proposal's newest record. Goes with replacementReason.

Respuesta

Created

custodian

string

requerido

Who holds the signed PDF: lender, downloadable here; or integrator, whose gateway holds it while the Lender keeps its digest.

evidenceRef

string

requerido

The integrator's reference to the signature evidence.

string

requerido

Record identifier (uuid).

loanApplicationId

string

requerido

Loan application identifier (uuid).

origin

string

requerido

Who issued what was signed: lender_emitted or client_issued.

originalDocumentDigest

string

requerido

sha-256 hex of the document that was signed. Empty when the integrator declared no original.

recordedAt

string

requerido

When the Lender recorded it (RFC3339, UTC).

signatories

object[] | null

requerido

Every party that signed, without name or document.

Show child attributes

signedAt

string

requerido

When the signature completed (RFC3339, UTC).

signedDocumentDigest

string

requerido

sha-256 hex the Lender computed over the signed PDF.

signedDocumentSize

integer<int64>

requerido

Size of the signed PDF in bytes.

creditInstrumentId

string

The Lender-emitted CCB that was signed (uuid). Absent when the client issued.

replacementReason

string

Why this record replaced the previous one. Absent on the first record.

supersedesId

string

The record this one replaced (uuid). Absent on the proposal's first record.

Productos de préstamo de Brasil

Operaciones de consignado

Ciclo de vida del producto

Versiones del producto

Configuración del producto

Tablas de tasa flotante

Plantillas de documento

Solicitudes de Préstamo

Instrumentos de crédito

Divulgaciones regulatorias y riesgo

Liquidación y prepago

Bajas contables y recuperación de crédito

Resumen y auditoría de cuenta

Cargos y calendario

Pagos

Transacciones

Cuentas por cobrar de pago devuelto

Fondos de cesión

Lotes de cesión

Excepciones y dossiers de la cesión

Contabilidad

Paneles de cartera

Jurisdicciones

Impuestos

Acceso de socios

Sesión

Fecha de negocio

Streaming

Manejo de errores

Eventos

Record signed credit instrument

Autorizaciones

Parámetros de ruta

Cuerpo

Respuesta