API reference¶
- API (Swagger UI)
- API (Redoc)
- Settings
SettingsSettings.environmentSettings.log_levelSettings.database_urlSettings.test_database_urlSettings.hash_keySettings.max_file_size_mbSettings.application_expiration_daysSettings.reminder_days_before_expirationSettings.reminder_days_before_lapsedSettings.reminder_days_before_lapsed_for_external_onboardingSettings.progress_to_remind_started_applicationsSettings.days_to_change_to_lapsedSettings.days_to_erase_borrowers_dataSettings.colombia_secop_app_tokenSettings.secop_pagination_limitSettings.secop_default_days_from_ultima_actualizacionSettings.email_sender_addressSettings.ocp_email_groupSettings.test_mail_receiverSettings.frontend_urlSettings.email_template_langSettings.images_base_urlSettings.aws_regionSettings.aws_access_keySettings.aws_client_secretSettings.cognito_pool_idSettings.cognito_client_idSettings.cognito_client_secretSettings.sentry_dsn
- Models
get_missing_data_keys()ActiveRecordMixinApplicationApplication.unarchived()Application.pending_introduction_reminder()Application.pending_submission_reminder()Application.pending_external_onboarding_reminder()Application.lapseable()Application.submitted()Application.archivable()Application.tzApplication.previous_awards()Application.rejected_lenders()Application.days_waiting_for_lender()Application.stage_as_rejected()Application.stage_as_approved()Application.application_lapsed_atApplication.archived_atApplication.award_borrower_identifierApplication.borrower_accepted_atApplication.borrower_accessed_external_onboarding_atApplication.borrower_credit_product_selected_atApplication.borrower_declined_atApplication.borrower_declined_dataApplication.borrower_declined_preferences_dataApplication.borrower_submitted_atApplication.completed_in_daysApplication.disbursed_final_amountApplication.expired_atApplication.information_requested_atApplication.lender_approved_atApplication.lender_approved_dataApplication.lender_rejected_atApplication.lender_rejected_dataApplication.lender_started_atApplication.overdued_atApplication.pending_documentsApplication.pending_email_confirmationApplication.primary_emailApplication.secop_data_verificationApplication.statusApplication.uuid
BorrowerDocumentLenderCreditProductMessageUserBorrowerBorrower.source_dataBorrower.statusBorrower.applicationsBorrower.awardsBorrower.addressBorrower.annual_revenueBorrower.borrower_identifierBorrower.created_atBorrower.currencyBorrower.declined_atBorrower.emailBorrower.idBorrower.is_msmeBorrower.legal_identifierBorrower.legal_nameBorrower.missing_dataBorrower.sectorBorrower.sizeBorrower.typeBorrower.updated_at
AwardAward.source_data_contractsAward.source_data_awardsAward.applicationsAward.borrowerAward.created_atAward.updated_atAward.last_updated()Award.award_amountAward.award_currencyAward.award_dateAward.borrower_idAward.buyer_nameAward.contract_statusAward.contracting_process_idAward.contractperiod_enddateAward.contractperiod_startdateAward.descriptionAward.entity_codeAward.idAward.missing_dataAward.payment_methodAward.previousAward.procurement_categoryAward.procurement_methodAward.source_contract_idAward.source_last_updated_atAward.source_urlAward.title
- Enumerations
UserTypeBorrowerStatusApplicationStatusMessageTypeMessageType.BORROWER_INVITATIONMessageType.BORROWER_PENDING_APPLICATION_REMINDERMessageType.BORROWER_PENDING_SUBMIT_REMINDERMessageType.BORROWER_EXTERNAL_ONBOARDING_REMINDERMessageType.SUBMISSION_COMPLETEDMessageType.NEW_APPLICATION_OCPMessageType.NEW_APPLICATION_FIMessageType.FI_MESSAGEMessageType.BORROWER_DOCUMENT_UPDATEDMessageType.REJECTED_APPLICATIONMessageType.APPROVED_APPLICATIONMessageType.OVERDUE_APPLICATIONMessageType.APPLICATION_COPIEDMessageType.EMAIL_CHANGE_CONFIRMATION
- Parsers
BasicUserResetPasswordSetupMFAAwardUpdateAwardUpdate.source_contract_idAwardUpdate.titleAwardUpdate.descriptionAwardUpdate.contracting_process_idAwardUpdate.award_currencyAwardUpdate.award_amountAwardUpdate.award_dateAwardUpdate.payment_methodAwardUpdate.buyer_nameAwardUpdate.source_urlAwardUpdate.entity_codeAwardUpdate.contract_statusAwardUpdate.contractperiod_startdateAwardUpdate.contractperiod_enddateAwardUpdate.procurement_methodAwardUpdate.procurement_category
LenderApprovedDataBorrowerUpdateUpdateDataFieldLenderRejectedApplicationApplicationBaseConfirmNewEmailChangeEmailVerifyBorrowerDocumentApplicationCreditOptionsApplicationSelectCreditProductUploadContractConfirmationApplicationEmailBorrowerApplicationDeclinePayloadApplicationDeclineFeedbackPayloadApplicationDeclineFeedbackPayload.dont_need_access_creditApplicationDeclineFeedbackPayload.already_have_acreditApplicationDeclineFeedbackPayload.preffer_to_go_to_bankApplicationDeclineFeedbackPayload.dont_want_access_creditApplicationDeclineFeedbackPayload.suspicious_emailApplicationDeclineFeedbackPayload.otherApplicationDeclineFeedbackPayload.other_comments
- Utilities
rollback_on_error()handle_skipped_award()get_db()TagsSortOrderStatisticRangeloads()get_object_or_404()generate_uuid()get_secret_hash()is_valid_email()validate_file()get_modified_data_fields()create_award_from_data_source()get_previous_awards_from_data_source()create_or_update_borrower_document()handle_external_onboarding()
- Exceptions
To view the API’s documentation in development, run the server and open http://127.0.0.1:8000/api/schema/swagger-ui/ or http://127.0.0.1:8000/api/schema/redoc/.