Register a guarantee on its first contract
curl --request POST \
--url https://lender.sandbox.lerian.net/api/v1/br/guarantees \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Idempotency: <x-idempotency>' \
--data '
{
"description": "Alienação fiduciária de veículo, Fiat Strada 2024",
"firstLink": {
"coveredPercentage": "100.00",
"loanApplicationId": "3b0f6c1e-5a7d-4e2b-9c41-0d8e2f6a7b19"
},
"scr": {
"situation": "01",
"type": "0000",
"valueType": "1"
},
"externalReference": "GAR-000123",
"identification": "9BD27805MP7123456",
"originalValue": "85000.00"
}
'package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://lender.sandbox.lerian.net/api/v1/br/guarantees"
payload := strings.NewReader("{\n \"description\": \"Alienação fiduciária de veículo, Fiat Strada 2024\",\n \"firstLink\": {\n \"coveredPercentage\": \"100.00\",\n \"loanApplicationId\": \"3b0f6c1e-5a7d-4e2b-9c41-0d8e2f6a7b19\"\n },\n \"scr\": {\n \"situation\": \"01\",\n \"type\": \"0000\",\n \"valueType\": \"1\"\n },\n \"externalReference\": \"GAR-000123\",\n \"identification\": \"9BD27805MP7123456\",\n \"originalValue\": \"85000.00\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Idempotency", "<x-idempotency>")
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: {
'X-Idempotency': '<x-idempotency>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
description: 'Alienação fiduciária de veículo, Fiat Strada 2024',
firstLink: {
coveredPercentage: '100.00',
loanApplicationId: '3b0f6c1e-5a7d-4e2b-9c41-0d8e2f6a7b19'
},
scr: {situation: '01', type: '0000', valueType: '1'},
externalReference: 'GAR-000123',
identification: '9BD27805MP7123456',
originalValue: '85000.00'
})
};
fetch('https://lender.sandbox.lerian.net/api/v1/br/guarantees', 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/br/guarantees"
payload = {
"description": "Alienação fiduciária de veículo, Fiat Strada 2024",
"firstLink": {
"coveredPercentage": "100.00",
"loanApplicationId": "3b0f6c1e-5a7d-4e2b-9c41-0d8e2f6a7b19"
},
"scr": {
"situation": "01",
"type": "0000",
"valueType": "1"
},
"externalReference": "GAR-000123",
"identification": "9BD27805MP7123456",
"originalValue": "85000.00"
}
headers = {
"X-Idempotency": "<x-idempotency>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"currency": "<string>",
"description": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"links": [
{
"coveredPercentage": "50.00",
"linkedAt": "2023-11-07T05:31:56Z",
"linkedBy": "<string>",
"loanApplicationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"midazOrganizationId": "<string>",
"receipts": [
{
"amount": "<string>",
"appliedAs": "repayment",
"heldAmount": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"loanApplicationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prepaidAmount": "<string>",
"receivedAt": "2023-11-07T05:31:56Z"
}
],
"scr": {
"situation": "<string>",
"type": "<string>",
"valueType": "<string>"
},
"executedAt": "2023-11-07T05:31:56Z",
"externalReference": "<string>",
"guarantorHolderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"identification": "<string>",
"originalValue": "<string>",
"revaluation": {
"reassessedOn": "<string>",
"percentage": "<string>",
"value": "<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"
}
}{
"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"
}
}Register a guarantee on its first contract
Registers a personal guarantee (a guarantor, found or created as a holder of the institution’s CRM) or a real one (identification and original value), with its SCR codes, its first situation and reassessment, linked to the contract it is born on at the percentage it covers. On a disbursed contract the guarantee_received compensation control opens in the same transaction.
POST
/
api
/
v1
/
br
/
guarantees
Register a guarantee on its first contract
curl --request POST \
--url https://lender.sandbox.lerian.net/api/v1/br/guarantees \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Idempotency: <x-idempotency>' \
--data '
{
"description": "Alienação fiduciária de veículo, Fiat Strada 2024",
"firstLink": {
"coveredPercentage": "100.00",
"loanApplicationId": "3b0f6c1e-5a7d-4e2b-9c41-0d8e2f6a7b19"
},
"scr": {
"situation": "01",
"type": "0000",
"valueType": "1"
},
"externalReference": "GAR-000123",
"identification": "9BD27805MP7123456",
"originalValue": "85000.00"
}
'package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://lender.sandbox.lerian.net/api/v1/br/guarantees"
payload := strings.NewReader("{\n \"description\": \"Alienação fiduciária de veículo, Fiat Strada 2024\",\n \"firstLink\": {\n \"coveredPercentage\": \"100.00\",\n \"loanApplicationId\": \"3b0f6c1e-5a7d-4e2b-9c41-0d8e2f6a7b19\"\n },\n \"scr\": {\n \"situation\": \"01\",\n \"type\": \"0000\",\n \"valueType\": \"1\"\n },\n \"externalReference\": \"GAR-000123\",\n \"identification\": \"9BD27805MP7123456\",\n \"originalValue\": \"85000.00\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Idempotency", "<x-idempotency>")
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: {
'X-Idempotency': '<x-idempotency>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
description: 'Alienação fiduciária de veículo, Fiat Strada 2024',
firstLink: {
coveredPercentage: '100.00',
loanApplicationId: '3b0f6c1e-5a7d-4e2b-9c41-0d8e2f6a7b19'
},
scr: {situation: '01', type: '0000', valueType: '1'},
externalReference: 'GAR-000123',
identification: '9BD27805MP7123456',
originalValue: '85000.00'
})
};
fetch('https://lender.sandbox.lerian.net/api/v1/br/guarantees', 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/br/guarantees"
payload = {
"description": "Alienação fiduciária de veículo, Fiat Strada 2024",
"firstLink": {
"coveredPercentage": "100.00",
"loanApplicationId": "3b0f6c1e-5a7d-4e2b-9c41-0d8e2f6a7b19"
},
"scr": {
"situation": "01",
"type": "0000",
"valueType": "1"
},
"externalReference": "GAR-000123",
"identification": "9BD27805MP7123456",
"originalValue": "85000.00"
}
headers = {
"X-Idempotency": "<x-idempotency>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"currency": "<string>",
"description": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"links": [
{
"coveredPercentage": "50.00",
"linkedAt": "2023-11-07T05:31:56Z",
"linkedBy": "<string>",
"loanApplicationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"midazOrganizationId": "<string>",
"receipts": [
{
"amount": "<string>",
"appliedAs": "repayment",
"heldAmount": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"loanApplicationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prepaidAmount": "<string>",
"receivedAt": "2023-11-07T05:31:56Z"
}
],
"scr": {
"situation": "<string>",
"type": "<string>",
"valueType": "<string>"
},
"executedAt": "2023-11-07T05:31:56Z",
"externalReference": "<string>",
"guarantorHolderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"identification": "<string>",
"originalValue": "<string>",
"revaluation": {
"reassessedOn": "<string>",
"percentage": "<string>",
"value": "<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"
}
}{
"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"
}
}Authorizations
JWT bearer token issued by the identity provider.
Headers
Canonical idempotency request ID. Required: a duplicate registers a second guarantee and opens a second compensation control.
Example:
"550e8400-e29b-41d4-a716-446655440005"
Body
application/json
The asset or the aval in general terms. Never a chassis, a plate, a registry number or a CPF: those go in identification and guarantor.
Example:
"Alienação fiduciária de veículo, Fiat Strada 2024"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The client's number for the guarantee, unique per institution, 1 to 64 characters with no leading or trailing space.
Example:
"GAR-000123"
Makes the guarantee personal.
Show child attributes
Show child attributes
Gar.Ident of a real guarantee: up to 21 characters (chassis, registry).
Example:
"9BD27805MP7123456"
Gar.VlrOrig of a real guarantee, 2 decimal places.
Example:
"85000.00"
The first reassessment, when there is one.
Show child attributes
Show child attributes
Response
Created
When it was registered.
Who registered it.
The currency of its first contract.
The asset or the aval in general terms.
The guarantee.
The standing links.
Show child attributes
Show child attributes
The institution the guarantee belongs to.
One item per contract of each execution.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The first execution receipt's instant; absent until one executes it.
The client's number for the guarantee.
The guarantor's CRM holder; absent on an asset.
Gar.Ident of a real guarantee.
Gar.VlrOrig.
The reassessment in force.
Show child attributes
Show child attributes
Was this page helpful?