Record the assignment set's endorsement term

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/assignment/sets/{setId}/term \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "coObligation": true,
  "idempotencyKey": "<string>",
  "artifact": "aSDinaTvuI8gbWludGxpZnk=",
  "artifactReference": "<string>"
}
'

package main

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

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/assignment/sets/{setId}/term"

	payload := strings.NewReader("{\n  \"coObligation\": true,\n  \"idempotencyKey\": \"<string>\",\n  \"artifact\": \"aSDinaTvuI8gbWludGxpZnk=\",\n  \"artifactReference\": \"<string>\"\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({
    coObligation: true,
    idempotencyKey: '<string>',
    artifact: 'aSDinaTvuI8gbWludGxpZnk=',
    artifactReference: '<string>'
  })
};

fetch('https://lender.sandbox.lerian.net/api/v1/assignment/sets/{setId}/term', 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/assignment/sets/{setId}/term"

payload = {
    "coObligation": True,
    "idempotencyKey": "<string>",
    "artifact": "aSDinaTvuI8gbWludGxpZnk=",
    "artifactReference": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "assignmentFundId": "<string>",
  "assignmentSetId": "<string>",
  "coObligation": true,
  "contentDigest": "<string>",
  "digestMethod": "sha256_pdf_normalized",
  "id": "<string>",
  "idempotencyKey": "<string>",
  "inputFingerprint": "<string>",
  "origin": "lender_emitted",
  "recordedAt": "<string>",
  "recordedBy": "<string>",
  "replayed": true,
  "setSnapshotDigest": "<string>",
  "sizeBytes": 123,
  "documentTemplateVersionId": "<string>",
  "externalReference": "<string>",
  "externalSource": "<string>",
  "pageGeometryRef": "<string>",
  "rendererVersion": "<string>",
  "specVersion": "<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"
  }
}

Record the assignment set's endorsement term

Records the endorsement/assignment term of one APPROVED set. Which of two paths runs is resolved from the fund’s own configured term mode, never from this request: for a fund the Lender emits for, the term is rendered from that fund’s own published endorsement-term template (a fund with no published template is refused — there is no generic layout); for a fund whose administrator generates the term, nothing is emitted and the administrator’s own artifact is registered, digested exactly as received. The row is append-only: the same idempotency key replays, a new key supersedes by order without erasing, and the set state term_signed is reachable only once a term exists.

POST

api

assignment

sets

{setId}

term

Record the assignment set's endorsement term

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/assignment/sets/{setId}/term \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "coObligation": true,
  "idempotencyKey": "<string>",
  "artifact": "aSDinaTvuI8gbWludGxpZnk=",
  "artifactReference": "<string>"
}
'

package main

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

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/assignment/sets/{setId}/term"

	payload := strings.NewReader("{\n  \"coObligation\": true,\n  \"idempotencyKey\": \"<string>\",\n  \"artifact\": \"aSDinaTvuI8gbWludGxpZnk=\",\n  \"artifactReference\": \"<string>\"\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({
    coObligation: true,
    idempotencyKey: '<string>',
    artifact: 'aSDinaTvuI8gbWludGxpZnk=',
    artifactReference: '<string>'
  })
};

fetch('https://lender.sandbox.lerian.net/api/v1/assignment/sets/{setId}/term', 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/assignment/sets/{setId}/term"

payload = {
    "coObligation": True,
    "idempotencyKey": "<string>",
    "artifact": "aSDinaTvuI8gbWludGxpZnk=",
    "artifactReference": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "assignmentFundId": "<string>",
  "assignmentSetId": "<string>",
  "coObligation": true,
  "contentDigest": "<string>",
  "digestMethod": "sha256_pdf_normalized",
  "id": "<string>",
  "idempotencyKey": "<string>",
  "inputFingerprint": "<string>",
  "origin": "lender_emitted",
  "recordedAt": "<string>",
  "recordedBy": "<string>",
  "replayed": true,
  "setSnapshotDigest": "<string>",
  "sizeBytes": 123,
  "documentTemplateVersionId": "<string>",
  "externalReference": "<string>",
  "externalSource": "<string>",
  "pageGeometryRef": "<string>",
  "rendererVersion": "<string>",
  "specVersion": "<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"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Path Parameters

setId

string<uuid>

required

Approved assignment set identifier (uuid).

Body

application/json

coObligation

boolean

required

Whether this term binds the assignor to answer for the receivable it sold (coobrigação). REQUIRED, and the only accepted value is false. An omitted field is refused rather than read as false: silence about a signed instrument is not a statement about its clauses, and this table is append-only, so a term recorded under an assumption cannot be corrected afterwards. Same reason riskRetention is required on the fund route. A term WITH co-obligation is a retained-risk assignment under Res. CMN 4.966: the receivable stays on the balance sheet, the price is recorded as a liability and the result is appropriated over the remaining term. That treatment does not exist yet, so the clause is refused rather than recorded and then booked as an outright sale. Declared here as a structured fact and never read out of the document's wording.

idempotencyKey

string

required

Caller idempotency key. The same key replays the same term; the same key over a different approved composition, a different template version or different artifact bytes is refused.

Required string length: 1 - 256

artifact

string<byte>

The administrator's own signed endorsement term, base64-encoded. Required if and only if this fund's administrator generates the term; refused for a fund the Lender emits for.

artifactReference

string

The administrator's own identifier for that document (its term/protocol number). Required alongside artifact.

Maximum string length: 256

Response

assignmentFundId

string

required

The fund whose configured mode decided the origin (uuid).

assignmentSetId

string

required

The approved set this term covers (uuid).

coObligation

boolean | null

required

Whether this term binds the assignor to answer for the receivable it sold (coobrigação). Always false on a term this service recorded: the retained-risk treatment TRUE implies does not exist yet. NULL on a term recorded before the declaration existed — that is a gap in the record, not a statement that the instrument carries no recourse, and it must not be read as false.

contentDigest

string

required

sha-256 of the term document.

digestMethod

enum<string>

required

What contentDigest was computed over: the normalized form of our own render, or the raw bytes exactly as received.

Available options:

sha256_pdf_normalized,

sha256_raw

string

required

Term record identifier (uuid).

idempotencyKey

string

required

Caller's idempotency key.

inputFingerprint

string

required

sha-256 of the caller-controlled comparison payload.

origin

enum<string>

required

Which path produced this term, resolved from the fund's configuration.

Available options:

lender_emitted,

administrator_generated

recordedAt

string

required

UTC registration instant (RFC3339).

recordedBy

string

required

Validated actor identity that recorded the term.

replayed

boolean

required

True when this call replayed an existing term under the same idempotency key rather than recording a new one.

setSnapshotDigest

string

required

sha-256 of the frozen approved composition this term covers.

sizeBytes

integer<int64>

required

Byte count custody actually stored.

documentTemplateVersionId

string

Template version rendered from; present only for a lender-emitted term.

externalReference

string

The administrator's own document identifier; administrator-generated only.

externalSource

string

The administrator on record for the fund; resolved server-side, administrator-generated only.

pageGeometryRef

string

Versioned page geometry; lender-emitted only.

rendererVersion

string

Render engine identity; lender-emitted only.

specVersion

string

Field-assembly rules version; lender-emitted only.

Brazil loan products

Consignado operations

Loan product lifecycle

Product versions

Product configuration

Floating-rate tables

Document templates

Loan Applications

Credit instruments

Regulatory disclosures and risk

Payoff and prepayment

Account overview and audit

Charges and schedule

Repayments

Transactions

Returned payment receivables

Assignment funds

Assignment sets

Assignment exceptions and registry

Accounting

Portfolio dashboards

Jurisdictions

Tax

Session

Streaming

Error handling

Events

Record the assignment set's endorsement term

Authorizations

Path Parameters

Body

Response