{ "openapi": "3.1.0", "info": { "title": "Lendly personal-loan MVP — draft contract", "version": "0.1.0", "description": "Design handoff only. No API is deployed. Vendor callbacks, full workforce administration, detailed ticket resolution, reporting exports and ledger APIs require separate lender/vendor contracts." }, "servers": [ { "url": "https://api.lendly.invalid", "description": "Reserved non-resolving example domain" } ], "paths": { "/v1/auth/otp/challenges": { "post": { "operationId": "post_v1_auth_otp_challenges", "summary": "Request borrower OTP challenge", "tags": [ "Public" ], "description": "Draft resource contract. Backend validates identity, ownership, lender scope and legal state transition.", "security": [], "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "description": "Scoped to caller and operation; body mismatch returns 409." } ], "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Challenge" } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope or role denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Version, state or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Business validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OtpChallenge" } } } } } }, "/v1/auth/otp/verify": { "post": { "operationId": "post_v1_auth_otp_verify", "summary": "Verify challenge and create session", "tags": [ "Public" ], "description": "Draft resource contract. Backend validates identity, ownership, lender scope and legal state transition.", "security": [], "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "description": "Scoped to caller and operation; body mismatch returns 409." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Session" } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope or role denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Version, state or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Business validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OtpVerify" } } } } } }, "/v1/applications": { "post": { "operationId": "post_v1_applications", "summary": "Create a draft application", "tags": [ "Borrower" ], "description": "Draft resource contract. Backend validates identity, ownership, lender scope and legal state transition.", "security": [ { "BorrowerBearer": [] } ], "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "description": "Scoped to caller and operation; body mismatch returns 409." } ], "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Application" } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope or role denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Version, state or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Business validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft" } } } } } }, "/v1/applications/{applicationId}": { "get": { "operationId": "get_v1_applications__applicationId_", "summary": "Read owned application and tracker state", "tags": [ "Borrower" ], "description": "Draft resource contract. Backend validates identity, ownership, lender scope and legal state transition.", "security": [ { "BorrowerBearer": [] } ], "parameters": [ { "in": "path", "name": "applicationId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Application" } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope or role denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Version, state or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Business validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "operationId": "patch_v1_applications__applicationId_", "summary": "Update a mutable draft", "tags": [ "Borrower" ], "description": "Requires If-Match with the current resource version. Immutable or submitted applications reject updates.", "security": [ { "BorrowerBearer": [] } ], "parameters": [ { "in": "path", "name": "applicationId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "description": "Scoped to caller and operation; body mismatch returns 409." }, { "in": "header", "name": "If-Match", "required": true, "schema": { "type": "string" }, "description": "Current quoted resource version, for example \"3\"." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Application" } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope or role denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Version, state or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Business validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft" } } } } } }, "/v1/applications/{applicationId}/submit": { "post": { "operationId": "post_v1_applications__applicationId__submit", "summary": "Validate gates and submit application", "tags": [ "Borrower" ], "description": "Draft resource contract. Backend validates identity, ownership, lender scope and legal state transition.", "security": [ { "BorrowerBearer": [] } ], "parameters": [ { "in": "path", "name": "applicationId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "description": "Scoped to caller and operation; body mismatch returns 409." } ], "responses": { "202": { "description": "Accepted; completion is asynchronous", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Application" } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope or role denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Version, state or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Business validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionCommand" } } } } } }, "/v1/applications/{applicationId}/consents": { "post": { "operationId": "post_v1_applications__applicationId__consents", "summary": "Record grant or withdrawal for a purpose", "tags": [ "Borrower" ], "description": "Draft resource contract. Backend validates identity, ownership, lender scope and legal state transition.", "security": [ { "BorrowerBearer": [] } ], "parameters": [ { "in": "path", "name": "applicationId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "description": "Scoped to caller and operation; body mismatch returns 409." } ], "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Receipt" } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope or role denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Version, state or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Business validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Consent" } } } } } }, "/v1/applications/{applicationId}/verification-sessions": { "post": { "operationId": "post_v1_applications__applicationId__verification_sessions", "summary": "Start authorized verification session", "tags": [ "Borrower" ], "description": "Draft resource contract. Backend validates identity, ownership, lender scope and legal state transition.", "security": [ { "BorrowerBearer": [] } ], "parameters": [ { "in": "path", "name": "applicationId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "description": "Scoped to caller and operation; body mismatch returns 409." } ], "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderSession" } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope or role denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Version, state or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Business validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificationRequest" } } } } } }, "/v1/applications/{applicationId}/offers": { "get": { "operationId": "get_v1_applications__applicationId__offers", "summary": "Read matching current offer", "tags": [ "Borrower" ], "description": "Draft resource contract. Backend validates identity, ownership, lender scope and legal state transition.", "security": [ { "BorrowerBearer": [] } ], "parameters": [ { "in": "path", "name": "applicationId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items", "nextCursor" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Offer" } }, "nextCursor": { "type": [ "string", "null" ] } } } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope or role denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Version, state or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Business validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/offers/{offerId}/accept": { "post": { "operationId": "post_v1_offers__offerId__accept", "summary": "Atomically accept valid offer and exact KFS", "tags": [ "Borrower" ], "description": "Reject expired/superseded offers, missing acknowledgements and version/hash mismatches. Uses lender clock.", "security": [ { "BorrowerBearer": [] } ], "parameters": [ { "in": "path", "name": "offerId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "description": "Scoped to caller and operation; body mismatch returns 409." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Receipt" } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope or role denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Version, state or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Business validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Acceptance" } } } } } }, "/v1/offers/{offerId}/contracting-sessions": { "post": { "operationId": "post_v1_offers__offerId__contracting_sessions", "summary": "Start agreement signing or mandate flow", "tags": [ "Borrower" ], "description": "Draft resource contract. Backend validates identity, ownership, lender scope and legal state transition.", "security": [ { "BorrowerBearer": [] } ], "parameters": [ { "in": "path", "name": "offerId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "description": "Scoped to caller and operation; body mismatch returns 409." } ], "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderSession" } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope or role denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Version, state or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Business validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractingRequest" } } } } } }, "/v1/loans/{loanId}": { "get": { "operationId": "get_v1_loans__loanId_", "summary": "Read lender-authoritative servicing projection", "tags": [ "Borrower" ], "description": "Draft resource contract. Backend validates identity, ownership, lender scope and legal state transition.", "security": [ { "BorrowerBearer": [] } ], "parameters": [ { "in": "path", "name": "loanId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Loan" } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope or role denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Version, state or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Business validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/loans/{loanId}/schedule": { "get": { "operationId": "get_v1_loans__loanId__schedule", "summary": "Read amortization and due state", "tags": [ "Borrower" ], "description": "Draft resource contract. Backend validates identity, ownership, lender scope and legal state transition.", "security": [ { "BorrowerBearer": [] } ], "parameters": [ { "in": "path", "name": "loanId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items", "nextCursor" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Installment" } }, "nextCursor": { "type": [ "string", "null" ] } } } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope or role denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Version, state or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Business validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/loans/{loanId}/payments": { "post": { "operationId": "post_v1_loans__loanId__payments", "summary": "Create lender-authorized payment intent", "tags": [ "Borrower" ], "description": "Draft resource contract. Backend validates identity, ownership, lender scope and legal state transition.", "security": [ { "BorrowerBearer": [] } ], "parameters": [ { "in": "path", "name": "loanId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "description": "Scoped to caller and operation; body mismatch returns 409." } ], "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment" } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope or role denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Version, state or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Business validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntent" } } } } } }, "/v1/payments/{paymentId}": { "get": { "operationId": "get_v1_payments__paymentId_", "summary": "Read payment status without assuming settlement", "tags": [ "Borrower" ], "description": "Draft resource contract. Backend validates identity, ownership, lender scope and legal state transition.", "security": [ { "BorrowerBearer": [] } ], "parameters": [ { "in": "path", "name": "paymentId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment" } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope or role denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Version, state or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Business validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/loans/{loanId}/exit-quotes": { "post": { "operationId": "post_v1_loans__loanId__exit_quotes", "summary": "Request an eligible cooling-off quote", "tags": [ "Borrower" ], "description": "Lender checks window and quotes complete exit amount. A request does not close a loan.", "security": [ { "BorrowerBearer": [] } ], "parameters": [ { "in": "path", "name": "loanId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "description": "Scoped to caller and operation; body mismatch returns 409." } ], "responses": { "202": { "description": "Accepted; completion is asynchronous", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExitQuote" } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope or role denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Version, state or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Business validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/tickets": { "post": { "operationId": "post_v1_tickets", "summary": "Create complaint or support ticket", "tags": [ "Borrower" ], "description": "Draft resource contract. Backend validates identity, ownership, lender scope and legal state transition.", "security": [ { "BorrowerBearer": [] } ], "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "description": "Scoped to caller and operation; body mismatch returns 409." } ], "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Receipt" } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope or role denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Version, state or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Business validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketRequest" } } } } } }, "/v1/tickets/{ticketId}": { "get": { "operationId": "get_v1_tickets__ticketId_", "summary": "Read own ticket status", "tags": [ "Borrower" ], "description": "Draft resource contract. Backend validates identity, ownership, lender scope and legal state transition.", "security": [ { "BorrowerBearer": [] } ], "parameters": [ { "in": "path", "name": "ticketId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Receipt" } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope or role denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Version, state or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Business validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/privacy-requests": { "post": { "operationId": "post_v1_privacy_requests", "summary": "Create purpose-scoped privacy request", "tags": [ "Borrower" ], "description": "Draft resource contract. Backend validates identity, ownership, lender scope and legal state transition.", "security": [ { "BorrowerBearer": [] } ], "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "description": "Scoped to caller and operation; body mismatch returns 409." } ], "responses": { "202": { "description": "Accepted; completion is asynchronous", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Receipt" } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope or role denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Version, state or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Business validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivacyRequest" } } } } } }, "/v1/admin/applications": { "get": { "operationId": "get_v1_admin_applications", "summary": "Read scoped application queue", "tags": [ "Workforce" ], "description": "Draft resource contract. Backend validates identity, ownership, lender scope and legal state transition.", "security": [ { "WorkforceBearer": [] } ], "parameters": [ { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items", "nextCursor" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Application" } }, "nextCursor": { "type": [ "string", "null" ] } } } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope or role denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Version, state or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Business validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/admin/applications/{applicationId}/proposals": { "post": { "operationId": "post_v1_admin_applications__applicationId__proposals", "summary": "Create a credit-maker proposal", "tags": [ "CreditMaker" ], "description": "Draft resource contract. Backend validates identity, ownership, lender scope and legal state transition.", "security": [ { "WorkforceBearer": [] } ], "parameters": [ { "in": "path", "name": "applicationId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "description": "Scoped to caller and operation; body mismatch returns 409." } ], "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Receipt" } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope or role denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Version, state or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Business validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecisionProposal" } } } } } }, "/v1/admin/applications/{applicationId}/confirmations": { "post": { "operationId": "post_v1_admin_applications__applicationId__confirmations", "summary": "Confirm independent current proposal", "tags": [ "CreditChecker" ], "description": "Require different authenticated maker/checker users; lock current application and proposal versions.", "security": [ { "WorkforceBearer": [] } ], "parameters": [ { "in": "path", "name": "applicationId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "description": "Scoped to caller and operation; body mismatch returns 409." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Application" } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope or role denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Version, state or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Business validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecisionConfirmation" } } } } } }, "/v1/admin/disbursements/{disbursementId}/enquiries": { "post": { "operationId": "post_v1_admin_disbursements__disbursementId__enquiries", "summary": "Enquire unknown transfer using original reference", "tags": [ "Operations" ], "description": "Draft resource contract. Backend validates identity, ownership, lender scope and legal state transition.", "security": [ { "WorkforceBearer": [] } ], "parameters": [ { "in": "path", "name": "disbursementId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "description": "Scoped to caller and operation; body mismatch returns 409." } ], "responses": { "202": { "description": "Accepted; completion is asynchronous", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Receipt" } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope or role denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Version, state or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Business validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/admin/audit-events": { "get": { "operationId": "get_v1_admin_audit_events", "summary": "Read scoped immutable audit events", "tags": [ "Auditor" ], "description": "Draft resource contract. Backend validates identity, ownership, lender scope and legal state transition.", "security": [ { "WorkforceBearer": [] } ], "parameters": [ { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items", "nextCursor" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AuditEvent" } }, "nextCursor": { "type": [ "string", "null" ] } } } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope or role denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Version, state or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Business validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "securitySchemes": { "BorrowerBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Borrower audience and own-customer scope." }, "WorkforceBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Workforce audience; MFA and role/lender scope checked server-side." } }, "schemas": { "Error": { "type": "object", "additionalProperties": false, "properties": { "error": { "type": "object", "required": [ "code", "message", "requestId" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } } } }, "required": [ "error" ] }, "Receipt": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "version": { "type": "integer", "minimum": 1 } }, "required": [ "id", "status", "version" ] }, "OtpChallenge": { "type": "object", "additionalProperties": false, "properties": { "mobile": { "type": "string", "pattern": "^[6-9][0-9]{9}$" } }, "required": [ "mobile" ] }, "OtpVerify": { "type": "object", "additionalProperties": false, "properties": { "challengeId": { "type": "string", "format": "uuid" }, "code": { "type": "string", "pattern": "^[0-9]{6}$" } }, "required": [ "challengeId", "code" ] }, "Challenge": { "type": "object", "additionalProperties": false, "properties": { "challengeId": { "type": "string", "format": "uuid" }, "expiresAt": { "type": "string", "format": "date-time" }, "resendAfterSeconds": { "type": "integer", "minimum": 1 } }, "required": [ "challengeId", "expiresAt", "resendAfterSeconds" ] }, "Session": { "type": "object", "additionalProperties": false, "properties": { "accessToken": { "type": "string" }, "refreshToken": { "type": "string" }, "expiresIn": { "type": "integer", "minimum": 1 } }, "required": [ "accessToken", "refreshToken", "expiresIn" ] }, "Draft": { "type": "object", "additionalProperties": false, "properties": { "amountPaise": { "type": "integer", "minimum": 2500000, "maximum": 30000000 }, "tenorMonths": { "type": "integer", "enum": [ 6, 12, 18, 24 ] }, "profileReference": { "type": "string" } }, "required": [ "amountPaise", "tenorMonths", "profileReference" ] }, "Application": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "DRAFT", "SUBMITTED", "CHECKS_PENDING", "ACTION_REQUIRED", "IN_REVIEW", "APPROVED", "DECLINED", "WITHDRAWN" ] }, "amountPaise": { "type": "integer", "minimum": 0, "description": "INR paise" }, "tenorMonths": { "type": "integer", "minimum": 1 }, "version": { "type": "integer", "minimum": 1 } }, "required": [ "id", "customerId", "status", "amountPaise", "tenorMonths", "version" ] }, "VersionCommand": { "type": "object", "additionalProperties": false, "properties": { "expectedVersion": { "type": "integer", "minimum": 1 } }, "required": [ "expectedVersion" ] }, "Consent": { "type": "object", "additionalProperties": false, "properties": { "purpose": { "type": "string" }, "noticeVersion": { "type": "string" }, "recipientIds": { "type": "array", "minItems": 1, "items": { "type": "string" } }, "action": { "type": "string", "enum": [ "GRANT", "REVOKE" ] } }, "required": [ "purpose", "noticeVersion", "recipientIds", "action" ] }, "VerificationRequest": { "type": "object", "additionalProperties": false, "properties": { "kind": { "type": "string", "enum": [ "IDENTITY", "INCOME", "BANK" ] }, "consentReference": { "type": "string", "format": "uuid" }, "expectedVersion": { "type": "integer", "minimum": 1 } }, "required": [ "kind", "consentReference", "expectedVersion" ] }, "ProviderSession": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "redirectUrl": { "type": "string", "format": "uri" }, "expiresAt": { "type": "string", "format": "date-time" }, "status": { "type": "string" } }, "required": [ "id", "redirectUrl", "expiresAt", "status" ] }, "Offer": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "applicationId": { "type": "string", "format": "uuid" }, "lenderName": { "type": "string" }, "principalPaise": { "type": "integer", "minimum": 0, "description": "INR paise" }, "annualInterestPercent": { "type": "number" }, "aprPercent": { "type": "number" }, "feePaise": { "type": "integer", "minimum": 0, "description": "INR paise" }, "taxPaise": { "type": "integer", "minimum": 0, "description": "INR paise" }, "netDisbursalPaise": { "type": "integer", "minimum": 0, "description": "INR paise" }, "installmentPaise": { "type": "integer", "minimum": 0, "description": "INR paise" }, "tenorMonths": { "type": "integer", "minimum": 1 }, "kfsDocumentId": { "type": "string", "format": "uuid" }, "kfsSha256": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" }, "version": { "type": "integer", "minimum": 1 }, "status": { "type": "string" } }, "required": [ "id", "applicationId", "lenderName", "principalPaise", "annualInterestPercent", "aprPercent", "feePaise", "taxPaise", "netDisbursalPaise", "installmentPaise", "tenorMonths", "kfsDocumentId", "kfsSha256", "expiresAt", "version", "status" ] }, "Acceptance": { "type": "object", "additionalProperties": false, "properties": { "expectedVersion": { "type": "integer", "minimum": 1 }, "kfsDocumentId": { "type": "string", "format": "uuid" }, "kfsSha256": { "type": "string" }, "acknowledged": { "type": "boolean", "const": true } }, "required": [ "expectedVersion", "kfsDocumentId", "kfsSha256", "acknowledged" ] }, "ContractingRequest": { "type": "object", "additionalProperties": false, "properties": { "kind": { "type": "string", "enum": [ "SIGNATURE", "MANDATE" ] }, "expectedVersion": { "type": "integer", "minimum": 1 } }, "required": [ "kind", "expectedVersion" ] }, "Loan": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "lenderLoanReference": { "type": "string" }, "status": { "type": "string", "enum": [ "ACTIVE", "OVERDUE", "EXIT_REQUESTED", "CLOSURE_PENDING", "CLOSED" ] }, "outstandingPaise": { "type": "integer", "minimum": 0, "description": "INR paise" }, "nextDueDate": { "type": [ "string", "null" ], "format": "date" }, "nextDuePaise": { "type": "integer", "minimum": 0, "description": "INR paise" } }, "required": [ "id", "lenderLoanReference", "status", "outstandingPaise", "nextDueDate", "nextDuePaise" ] }, "Installment": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "sequence": { "type": "integer", "minimum": 1 }, "dueDate": { "type": "string", "format": "date" }, "principalPaise": { "type": "integer", "minimum": 0, "description": "INR paise" }, "interestPaise": { "type": "integer", "minimum": 0, "description": "INR paise" }, "amountDuePaise": { "type": "integer", "minimum": 0, "description": "INR paise" }, "settledPaise": { "type": "integer", "minimum": 0, "description": "INR paise" }, "status": { "type": "string" } }, "required": [ "id", "sequence", "dueDate", "principalPaise", "interestPaise", "amountDuePaise", "settledPaise", "status" ] }, "PaymentIntent": { "type": "object", "additionalProperties": false, "properties": { "installmentId": { "type": "string", "format": "uuid" }, "amountPaise": { "type": "integer", "minimum": 0, "description": "INR paise" } }, "required": [ "installmentId", "amountPaise" ] }, "Payment": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "providerReference": { "type": "string" }, "status": { "type": "string", "enum": [ "CREATED", "PENDING", "UNKNOWN", "SETTLED", "FAILED", "REVERSED" ] }, "amountPaise": { "type": "integer", "minimum": 0, "description": "INR paise" }, "redirectUrl": { "type": "string", "format": "uri" } }, "required": [ "id", "providerReference", "status", "amountPaise", "redirectUrl" ] }, "TicketRequest": { "type": "object", "additionalProperties": false, "properties": { "category": { "type": "string", "enum": [ "APPLICATION", "PAYMENT", "COMPLAINT", "OTHER" ] }, "message": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": [ "category", "message" ] }, "PrivacyRequest": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "enum": [ "ACCESS", "WITHDRAW_CONSENT", "DELETE_REVIEW" ] }, "purpose": { "type": "string" } }, "required": [ "type", "purpose" ] }, "DecisionProposal": { "type": "object", "additionalProperties": false, "properties": { "expectedVersion": { "type": "integer", "minimum": 1 }, "outcome": { "type": "string", "enum": [ "APPROVED", "DECLINED", "ACTION_REQUIRED" ] }, "reasonCode": { "type": "string" }, "rationale": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": [ "expectedVersion", "outcome", "reasonCode", "rationale" ] }, "DecisionConfirmation": { "type": "object", "additionalProperties": false, "properties": { "proposalId": { "type": "string", "format": "uuid" }, "expectedVersion": { "type": "integer", "minimum": 1 } }, "required": [ "proposalId", "expectedVersion" ] }, "AuditEvent": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "actorId": { "type": "string", "format": "uuid" }, "action": { "type": "string" }, "resourceReference": { "type": "string" }, "occurredAt": { "type": "string", "format": "date-time" }, "requestId": { "type": "string" } }, "required": [ "id", "actorId", "action", "resourceReference", "occurredAt", "requestId" ] }, "ExitQuote": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "loanId": { "type": "string", "format": "uuid" }, "amountPaise": { "type": "integer", "minimum": 0, "description": "INR paise" }, "expiresAt": { "type": "string", "format": "date-time" }, "status": { "type": "string" } }, "required": [ "id", "loanId", "amountPaise", "expiresAt", "status" ] } } } }