The public API reuses a number of request and response models across endpoint groups. This page is a quick guide to the most commonly referenced object names.
UserRequest and UserResponse are used for customer creation.
ApplicationRequest is used when creating an application for an existing customer.
ApplicationAndCustomerRequest is used for combined customer-and-application creation flows.
ApplicationCustomerResponse returns the created application and customer identifiers.
SliderRequest, CalculationRequest, and CalculationResponse are used by calculation routes.
CompanyDataRequest, PrimaryApplicantRequest, and SecondaryApplicantRequest are used during application approval.
SignaturesRequest is used when signing contracts.
ContractDetails is returned by the contract details route.
LoanResponse, LoanBalanceResponse, and DashboardLoanRepaymentResponse are common loan read responses.
LineOfCreditWithdrawalRequest, InvoiceWithdrawalRequest, and their response types are used for withdrawal flows.
CommunicationRequest is used for application messaging.
WebhookSubscription is the input object for webhook registration and update flows.