v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Loan Applications

Ingest BR capitalization clause consent

Hashes clause text server-side and stores an append-only consent artifact for BR-profile disbursement guards.

post/api/v1/br/loan-applications/{id}/capitalization-consents

Path parameters

idstring uuid required

Loan application identifier.

Request body

acceptedAtstring date-time required

RFC3339 timestamp the borrower accepted the clause.

clauseTextstring required

Raw capitalization clause text presented to the borrower.

clauseTextHashstring required

Client-computed SHA-256 hex digest of the canonicalized clause text.

consentEvidencestring required

Opaque evidence reference proving the borrower accepted the clause.

Example request

{
  "clauseTextHash": "a3b1c2d4e5f60718293a4b5c6d7e8f90a1b2c3d4e5f60718293a4b5c6d7e8f90"
}

Response

Created

acceptedAtstring required

RFC3339 UTC timestamp when the borrower accepted the clause.

acceptedByActorstring required

Authenticated actor identity (resolved from request context) that accepted the clause.

clauseTextHashstring required

Server-recomputed SHA-256 hex digest of the canonicalized clause text (64 lowercase hex chars).

consentEvidencestring required

Opaque evidence reference proving the borrower accepted the clause.

createdAtstring required

RFC3339 UTC timestamp when the artifact was persisted.

idstring required

Server-generated UUID of the persisted consent artifact.

jurisdictionCodestring required

ISO 3166-1 alpha-2 jurisdiction code (e.g. "BR").

loanApplicationIdstring required

UUID of the loan application this consent is attached to.

profileVersionstring required

Jurisdiction profile version in effect when the disclosure was presented (e.g. "1.0.0").

Example response

{
  "acceptedAt": "2026-06-14T12:00:00Z",
  "clauseTextHash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
  "createdAt": "2026-06-14T12:00:00Z",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "jurisdictionCode": "BR",
  "loanApplicationId": "550e8400-e29b-41d4-a716-446655440001",
  "profileVersion": "1.0.0"
}